Skip to content

Commit

Permalink
fix(docs): improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
almeidabbm committed Nov 30, 2023
1 parent 922db84 commit 1bd40d2
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ npm install -g @slauth.io/slauth
1. Set the `OPENAI_API_KEY` environment variable: `export OPENAI_API_KEY=<key>`
2. Run `slauth --help` to see available commands

### Examples
### Commands

#### Scan command
#### Scan

The scan command will look for any calls of your Cloud Provider `sdk` in your git repository and generate the necessary permissions for it.

Expand Down Expand Up @@ -97,7 +97,7 @@ Detected Policies:
- `-m, --openai-model <openaiModel>` select the openai model to use (choices: "gpt-3.5-turbo-16k", "gpt-4-32k")
- `-o, --output-file <outputFile>` write generated policies to a file instead of stdout

### Selecting which OpenAI Model to use
#### Selecting which OpenAI Model to use

By default `slauth` will use `gpt-4-32k` as it provides the best results. You can still choose to use other models to scan you repo, specially if cost is a concern:

Expand All @@ -109,9 +109,16 @@ slauth scan -p aws -m gpt-3.5-turbo-16k ./path/to/my/repository

Available models:

- `gpt-3.5-turbo-16k`
- `gpt-3.5-turbo-16k` (results with this model might be incomplete)
- `gpt-4-32k` (default)

#### Example repos to test with

In case you want to give the CLI a quick test you can fork the following repositories.

- aws-sdk: <https://github.com/slauth-io/aws-sdk-tester>
- google-cloud sdk: <https://github.com/slauth-io/gcp-sdk-tester>

### Running in CI/CD

Slauth being a CLI, it can be easily integrated in your CI/CD pipelines.
Expand Down

0 comments on commit 1bd40d2

Please sign in to comment.