Skip to content

Update displayed CLI options in README.md #144

@ralftrellis

Description

@ralftrellis

It would be helpful to newer users to update the README.md to show the current options supported by the CLI tool. In particular the --output-file option (not shown in README.md) would be useful to some users using the CLI to query J1.

% npx j1 --help
Usage: j1 [options]

Options:
  -v, --version             output the version number
  -a, --account <name>      JupiterOne account name.
  -u, --user <email>        JupiterOne user email.
  -k, --key <apiToken>      JupiterOne API access token.
  -q, --query <j1ql>        Execute a query.
  -o, --operation <action>  Supported operations:
                            create,update,upsert,delete,bulk-delete,provision-alert-rule-pack
  -e, --entity              Specifies entity operations.
  -r, --relationship        Specifies relationship operations.
  -l, --alert               Specifies alert rule operations.
  -w, --question            Specifies question operations. A question is
                            answered by one or more queries.
  -f, --input-file <dir>    Input JSON file. Or the filename of the alert rule
                            pack.
  --hard-delete             Optionally force hard deletion of entities (default
                            is soft delete).
  --delete-duplicates       Optionally force deletion of duplicate entities
                            with identical keys.
  --output-file <file>      Writes query result to specified output file, or
                            results.json by default (default: "results.json")
  --api-base-url <url>      Optionally specify base URL to use during
                            execution. (defaults to
                            `https://api.us.jupiterone.io`)
  -h, --help                display help for command

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions