Skip to content

Commit

Permalink
Change help.md to readme.md and change to read from readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Shoreasg committed May 19, 2024
1 parent 200519e commit 27a4ad7
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
12 changes: 9 additions & 3 deletions help.md → README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ snyk-rest-cli helps you to call the REST API and provide you functionalities tha

## How to get started

1. Input --SNYK_API_TOKEN=<`SnykToken/ServiceToken`>
1. Input --snyk_token=<`SnykToken/ServiceToken`>
2. Input --version=<`The requested version of the endpoint to process the request`>
3. Look at the available commands below and add the required flags for the command to work

Expand All @@ -21,8 +21,14 @@ To learn more about each snyk-rest-cli CLI command, use the `--help` option`.

**Note:** The help on the docs site is the same as the `--help` in the CLI.

### `snyk auth`
### `snyk-rest-cli --get_all_orgs_group`

Authenticate Snyk CLI with a Snyk account.
Get all orgs for the specify group.

# Required flags

1. `--group_id`: Your group id

# optional flags

1. `--starting_after`: Return the page of results immediately after this cursor
2 changes: 1 addition & 1 deletion index.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ const myCustomArgv = minimist(process.argv.slice(2), {
});

function readHelp() {
const helpMD = fs.readFileSync("help.md", "utf8");
const helpMD = fs.readFileSync("README.md", "utf8");
echo(renderMarkdown(helpMD));
}

Expand Down

0 comments on commit 27a4ad7

Please sign in to comment.