Skip to content

Commit

Permalink
GitBook: [main] one page modified
Browse files Browse the repository at this point in the history
  • Loading branch information
awilkes authored and gitbook-bot committed Mar 5, 2021
1 parent 7b5c04b commit 5a28672
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions docs/resources/cli-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ $ export LAUNCHABLE_TOKEN=your_API_token

### Verify

Then run `launchable verify` in your CI environment to see if you've successfully configured the CLI. If it succeeds, you'll see a message like the one below. Otherwise, you'll see an error message.
Then run `launchable verify` in your CI environment to see if you've successfully configured the CLI. If it succeeds, you'll see a message like the one below. If you see an error message, see [Troubleshooting](troubleshooting.md).

```bash
$ launchable verify
Expand Down Expand Up @@ -171,7 +171,17 @@ In order to avoid disrupting your CI/test process, the Launchable CLI is designe

Therefore, we recommend you keep `launchable verify || true` in a recognizable spot in your CI process. This way, when you suspect a problem in Launchable, you can check the output of this command as a starting point.

{% hint style="info" %}
This documentation is current as of CLI version `1.3.1`
{% endhint %}
## Global options

### --log-level

You can use the `--log-level` option to output extra information from each command.

`--log-level audit` is particularly useful if you want to see exactly what data gets passed to Launchable when you run CLI commands. For example:

```text
% launchable --log-level audit record build --name 1234 --source src
Processed 1 commits
AUDIT:launchable:send request method:post path:/intake/organizations/launchableinc/workspaces/awilkes/builds headers:{'Content-Type': 'application/json'} args:{'data': b'{"buildNumber": "1234", "commitHashes": [{"repositoryName": "src", "commitHash": "45b2e6d9df8e0013334354f30df1978c8b4196f8"}]}', 'timeout': (5, 60)}
```

0 comments on commit 5a28672

Please sign in to comment.