Skip to content

Commit

Permalink
chore: updated readme
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Jones <[email protected]>
  • Loading branch information
AlexsJones committed Jan 12, 2024
1 parent ed7b430 commit 1c3d259
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@ Or with Cargo
cargo install isotope
```

## Usage
## Setup

1. Set environment variables for AWS access
Set environment variables for AWS access

```
export AWS_ACCESS_KEY=""
Expand All @@ -79,26 +79,25 @@ export AWS_REGION="" ( e.g. eu-west-2 //wherever your VPC is )
export BEDROCK_REGION="eu-central-1" ( e.g. us-east-1,us-west-2, ap-southeast-1, ap-northeast-1 )
export BEDROCK_MODEL="anthropic.claude-v2" ( e.g. anthropic.claude-v2, anthropic.claude-v1, anthropic.claude-instant-v1 )
```
2. Run all isotope analyzers

## Usage

_Run all isotope analyzers_
```
isotope analyze
```

Optionally for a single analyzer

_Optionally for a single analyzer_
```
isotope analyze -a S3
```

4. Use Bedrock AI

_Use Bedrock AI_
```
isotope analyze --explain
```

5. Debug in interative mode

_Debug in interactive mode_
```
isotope analyze --explain --interactive
```
Expand Down

0 comments on commit 1c3d259

Please sign in to comment.