Skip to content

Document authPolicy map #2

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

Merged
vaibhavpandeyvpz merged 1 commit into from
Mar 14, 2026
Merged

Document authPolicy map #2

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
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,12 +129,25 @@ Example configuration:
"defaultAgent": "cursor",
"format": "text",
"permissionMode": "approve-reads",
"authPolicy": "skip",
"auth": {},
"agents": {
"cursor": { "command": "agent", "args": ["acp"] }
}
}
```

### Authentication

Some agents advertise auth methods in their `initialize` response (e.g., API key, OAuth). codeye handles this after initialization:

| Field | Purpose |
| ------------- | ----------------------------------------------------------------------- |
| **auth** | Map of credential keys to values (e.g., `api_key`, `gemini-api-key`). Passed to the agent via env vars and used for the ACP `authenticate` call. |
| **authPolicy**| `"skip"` (default): proceed without auth if no credentials found. `"fail"`: abort with an error when the agent advertises auth methods but no matching credentials exist. |

Credentials are resolved from (in order): env vars `CODEYE_AUTH_<TOKEN>` or `<TOKEN>`, then the `auth` config map. Use `authPolicy: "fail"` in automation when the agent requires authentication; use `"skip"` for agents that work without it or already have cached creds.

## Automation & CI

codeye is designed for headless, scriptable workflows:
Expand Down
Loading