Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lloesche authored Jul 25, 2024
1 parent 627b731 commit 851dbd3
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,22 @@ brew install someengineering/tap/fixctl

## Usage
```
Usage of fixctl:
--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")
--endpoint: API endpoint URL (env FIX_ENDPOINT) (default "https://app.fix.security")
--format: Output format: json, yaml or csv (default "json")
--help: Display help information (default "false")
--search: Search string (default "")
--token: Auth token (env FIX_TOKEN) (default "")
--with-edges: Include edges in search results (default "false")
--workspace: Workspace ID (env FIX_WORKSPACE) (default "")
fixctl allows you to search the Fix Security Graph and export cloud inventory data for further processing.
Usage:
fixctl [flags]
Flags:
--csv-headers string CSV headers (default "id,name,kind,/ancestors.cloud.reported.id,/ancestors.account.reported.id,/ancestors.region.reported.id")
--endpoint string API endpoint URL (env FIX_ENDPOINT) (default "https://app.fix.security")
--format string Output format: json, yaml or csv (default "json")
-h, --help help for fixctl
--search string Search string
--token string Auth token (env FIX_TOKEN)
--verbose enable verbose output
-v, --version version for fixctl
--with-edges Include edges in search results
--workspace string Workspace ID (env FIX_WORKSPACE)
```

If an environment variable is set, it will be used and the command line flag ignored.
Expand Down

0 comments on commit 851dbd3

Please sign in to comment.