Skip to content

Commit

Permalink
doc: update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Ugochukwu Onyebuchi committed Mar 24, 2023
1 parent e2c45cf commit 3ec350b
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,25 @@ ChatShell reads your OpenAI API key from a JSON configuration file named config.

Here's an example of what your configuration file should look like:

`{
``` json
{
"OPENAI_AUTH_TOKEN": "your_api_key_here"
}`
}
```

## Usage

To use ChatShell, simply run the ask command followed by your query. For example:

`bash
chatshell ask "How do I list all files in a directory?"`
`chatshell ask "How do I list all files in a directory?"`


This will return a shell command that you can use to list all files in a directory.

You can also enter chat mode by using the -c flag:


chatshell ask -c "Hello, how are you?"
`chatshell ask -c "Hello, how are you?"`


This will enter chat mode and allow you to have a normal conversation with ChatGPT.
Expand Down

0 comments on commit 3ec350b

Please sign in to comment.