Skip to content

docs(readme): clarify custom agent model syntax #174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LaishGlenberg wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(readme): clarify custom agent model syntax #174

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,20 @@ Example `settings.json` override for compatible API proxies:
| One-click install | ✅ | ❌ | ✅ |
| API key in OS keychain | ✅ | ❌ | ⚠️ varies |

## Custom Agents (.agent.md)

- Use this exact syntax for the `model` field, with the lowercase vendor name 'deepseek' in parenthesis

```yaml
model: 'DeepSeek V4 Flash (deepseek)'
```

- If using both Pro and Flash

```yaml
model: ['DeepSeek V4 Flash (deepseek)', 'DeepSeek V4 Pro (deepseek)']
```

## License

[MIT](LICENSE)