Skip to content

Commit 20313fa

Browse files
authored
Update usage (#177)
1 parent a9eee01 commit 20313fa

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

docs/cli.mdx

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,22 @@ $ brew install someengineering/tap/fixctl
3131
## Usage
3232

3333
```bash
34-
Usage of fixctl:
35-
--csv-headers: CSV headers (comma-separated, relative to /reported by default) (default "id,name,kind,/ancestors.cloud.reported.id,/ancestors.account.reported.id,/ancestors.region.reported.id")
36-
--endpoint: API endpoint URL (env FIX_ENDPOINT) (default "https://app.fix.security")
37-
--format: Output format: json, yaml or csv (default "json")
38-
--help: Display help information (default "false")
39-
--search: Search string (default "")
40-
--token: Auth token (env FIX_TOKEN) (default "")
41-
--with-edges: Include edges in search results (default "false")
42-
--workspace: Workspace ID (env FIX_WORKSPACE) (default "")
34+
fixctl allows you to search the Fix Security Graph and export cloud inventory data for further processing.
35+
36+
Usage:
37+
fixctl [flags]
38+
39+
Flags:
40+
--csv-headers string CSV headers (default "id,name,kind,/ancestors.cloud.reported.id,/ancestors.account.reported.id,/ancestors.region.reported.id")
41+
--endpoint string API endpoint URL (env FIX_ENDPOINT) (default "https://app.fix.security")
42+
--format string Output format: json, yaml or csv (default "json")
43+
-h, --help help for fixctl
44+
--search string Search string
45+
--token string Auth token (env FIX_TOKEN)
46+
--verbose enable verbose output
47+
-v, --version version for fixctl
48+
--with-edges Include edges in search results
49+
--workspace string Workspace ID (env FIX_WORKSPACE)
4350
```
4451

4552
Go to your [user settings](https://app.fix.security/user-settings) and create an API token. Set the `FIX_TOKEN` environment variable to the token value.

0 commit comments

Comments
 (0)