Skip to content

Commit

Permalink
Update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
yaph committed Oct 16, 2024
1 parent c1ed25f commit 3075d97
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,37 @@ For GitHub models, set the environment variable GITHUB_TOKEN to your token. In B
export GITHUB_TOKEN=YOUR_GITHUB_TOKEN
```

After successful installation and setup you can launch the chat console by typing `charla` in your terminal.
## Usage

After successful installation and setup you can launch the chat console with the `charla` command in your terminal.

If you use Charla with Ollama, the default provider, you only need to specify the model to use, e.g.:

```console
charla -m phi3
```

If you want to use GitHub Models, you have to set the provider:

```console
charla -m gpt-4o --provider github
```

You can set a default model and change the default provider in your user settings file.

## Settings

Settings can be specified as command line arguments and in the settings file. Command line arguments have the highest priority. The location of your settings file depends on your operating system. Use the following command to show the location:

```console
charla settings --location
```

Example settings for using OpenAI's GPT-4o model and the GitHub Models service by default.

```json
{
"model": "phi3",
"model": "gpt-4o",
"chats_path": "./chats",
"prompt_history": "./prompt-history.txt",
"provider": "github",
Expand Down

0 comments on commit 3075d97

Please sign in to comment.