|
1 | 1 | # `appcircle build download-log` |
2 | 2 |
|
3 | | -Download build log to the given directory on your machine. |
| 3 | +Download build logs to the specified directory. |
4 | 4 |
|
5 | 5 | ```plaintext |
6 | 6 | appcircle build download-log [options] |
7 | 7 | ``` |
8 | 8 |
|
| 9 | +## Description |
| 10 | + |
| 11 | +This command downloads build logs to your computer. You can download logs using two different methods: |
| 12 | + |
| 13 | +1. Using `taskId` (preferred method) |
| 14 | +2. Using `commitId` and `buildId` (alternative method) |
| 15 | + |
| 16 | +When downloading logs, the CLI automatically checks if logs are ready at 5-second intervals for up to 2 minutes. |
| 17 | + |
9 | 18 | ## Options |
10 | 19 |
|
11 | 20 | ```plaintext |
12 | | - --path <string> [OPTIONAL] The path for log to be downloaded. Defaults to the current directory |
| 21 | + --path <string> [OPTIONAL] Path where logs will be downloaded. Defaults to current directory or Downloads folder |
13 | 22 |
|
14 | | - --commitId <uuid> Commit ID of your build |
| 23 | + --taskId <uuid> [METHOD 1] Task ID for the build process |
15 | 24 |
|
16 | | - --buildId <uuid> Build ID |
| 25 | + --commitId <uuid> [METHOD 2] Commit ID |
| 26 | +
|
| 27 | + --buildId <uuid> [METHOD 2] Build ID |
17 | 28 | ``` |
| 29 | + |
| 30 | +## Features |
| 31 | + |
| 32 | +- User-friendly animation is displayed while build logs are being prepared |
| 33 | +- Automatically switches to alternative download methods if the primary method fails |
| 34 | +- Logs are saved with descriptive filenames: `build-task-{taskId}-log.txt` or `{buildId}-log.txt` |
| 35 | +- Full file path is displayed to easily find log files |
| 36 | + |
18 | 37 | ## Options inherited from parent commands |
19 | 38 |
|
20 | 39 | ```plaintext |
21 | 40 | --help Show help for command |
| 41 | +``` |
| 42 | + |
| 43 | +## Examples |
| 44 | + |
| 45 | +```plaintext |
| 46 | +# Download logs using Task ID (preferred method) |
| 47 | +appcircle build download-log --taskId="1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p" |
| 48 | +
|
| 49 | +# Download logs using Commit ID and Build ID |
| 50 | +appcircle build download-log --commitId="1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p" --buildId="7q8r9s0t-1u2v-3w4x-5y6z-7a8b9c0d1e2f" |
| 51 | +
|
| 52 | +# Download to a specific directory |
| 53 | +appcircle build download-log --taskId="1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p" --path="/Users/username/Downloads" |
22 | 54 | ``` |
0 commit comments