Skip to content

Commit 9f2c61c

Browse files
committed
fix: enhance README with details on AI connection management and migration notes
1 parent f304107 commit 9f2c61c

1 file changed

Lines changed: 3 additions & 12 deletions

File tree

README.md

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ Providers are configured during setup and stored as **named connections** in `~/
201201

202202
### Saved connections (multiple providers & accounts)
203203

204-
eckra stores several provider configurations side by side, including different providers and/or multiple accounts for the same provider (e.g. a work and a personal OpenAI key). One connection is active at a time and every AI call uses it. With no explicit choice, eckra falls back to the `default` connection.
204+
eckra stores several provider configurations side by side, including different providers and/or multiple accounts for the same provider (e.g. a work and a personal OpenAI key). One connection is active at a time and every AI call uses it. With no explicit choice, eckra falls back to the `default` connection. You can override this per run with `ECKRA_ACTIVE_AI_CONNECTION` or pin a connection to a single repository with `eckra provider use <name> --local`, which is saved in `.eckrarc`.
205205

206206
The AI surfaces expose exactly two actions: **Switch Provider / Account** (pick an existing connection) and **Manage Providers** (everything else: add, edit credentials/model per connection, rename, delete). They live in the Settings menu and behind `eckra model`:
207207

@@ -218,15 +218,6 @@ eckra provider rename work is # Rename (stays active if it was)
218218
eckra provider remove work -y # Delete
219219
```
220220

221-
> [!NOTE]
222-
> Upgrading from an older eckra? Your existing flat settings are migrated automatically into a `default` connection on first run, so nothing to do. The old keys stay in the file for downgrade safety but are no longer used.
223-
224-
> [!NOTE]
225-
> The active connection can also be set per environment with `ECKRA_ACTIVE_AI_CONNECTION`, or per repository via `.eckrarc` (`eckra config set activeAiConnection <name> --local`).
226-
227-
> [!NOTE]
228-
> Per-repository overrides go in `.eckrarc` (gitignored, as it can hold API keys).
229-
230221
### Config CLI
231222

232223
```bash
@@ -241,9 +232,9 @@ eckra config path # Config file path
241232
```
242233

243234
> [!NOTE]
244-
> Add `--local` to target the project's `.eckrarc` instead.
235+
> Add `--local` to target the project's `.eckrarc` instead. This file is gitignored as it can hold API keys.
245236
246-
A few useful keys: `commitType` (commit message format), `subjectMaxLength` (max subject characters, default 50), `locale` (language for messages, default `en`), `timeout` (AI request timeout in ms, default 30000), and `activeAiConnection` (the saved connection in use). Provider credentials and models live inside named connections. Manage them with `eckra provider` / `eckra model`, not `eckra config set` (which now rejects those keys with guidance).
237+
A few useful keys: `commitType` (commit message format), `subjectMaxLength` (max subject characters, default 50), `locale` (language for messages, default `en`), `timeout` (AI request timeout in ms, default 30000), and `activeAiConnection` (the saved connection in use). Provider credentials and models live inside named connections. Manage them with `eckra provider` / `eckra model`, not `eckra config set` (which now rejects those keys with guidance). If you are upgrading from an older version, existing flat settings are migrated automatically into a `default` connection on first run and the old keys are kept for downgrade safety.
247238

248239
### Health check
249240

0 commit comments

Comments
 (0)