You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 367201a
Browse filesBrowse the repository at this point in the historyBrowse files
docs: state the new Altimate Base auto-registration behavior
Every doc still promised the retired flow — "registration only after an
explicit confirmation that defaults to No" — after auto-registration with no
consent dialog shipped. Updates the security FAQ, quickstart, provider docs,
README, and network reference to state the new behavior (a fresh install
with no model of its own registers Altimate Base automatically, the
disclosure is shown once) and the actual opt-outs
(`ALTIMATE_BASE_AUTO_REGISTER=0`, `altimate providers logout altimate-base`,
`enabled_providers`/`disabled_providers`) — noting that only the env var
stops the background registration call itself.
`docs/docs/configure/providers.md` also drops the stale claim that
`declinedManagedBaseDefault` still keeps public Zen ahead of registered Base
for a migrating Big Pickle user — Zen's keyless tier rejects unauthenticated
traffic outright now, so there's no working choice left to honor; the flag
is read for backward compatibility only.
`docs/docs/reference/telemetry.md`: corrected `altimate_base_registration`'s
"after consent" wording, and marked `altimate_base_confirm_shown` /
`altimate_base_choice` / the `altimate_base_back` picker trigger as legacy —
still defined in the event schema, but no longer emitted now that the
consent dialog they recorded is gone.
Logging/retention wording is unchanged verbatim from `ALTIMATE_BASE_DISCLOSURE`
(verified against `test/altimate/altimate-base-disclosure-claims.test.ts`,
which checks the docs note stays a superset of the in-app notice).
Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
Choose **Altimate Base** from the first-run picker or `/connect`. A disclosure is shown before any
66
-
registration request; **No** is selected by default. After registration, the model is available as
65
+
Choose **Altimate Base** from the first-run picker or `/connect` — or do nothing at all: a fresh
66
+
install with no model of its own registers it automatically, before your first prompt, so it works
67
+
the same way headlessly (`run`, `serve`, `acp`, `web`). There is no confirmation dialog to accept.
68
+
The disclosure above is printed once per install the first time this happens — a toast in the TUI,
69
+
or a one-line notice to stderr for a headless entrypoint (skipped when `ALTIMATE_CLI_CLIENT=datamates`,
70
+
since the VS Code extension shows its own notice). After registration, the model is available as
67
71
`altimate-free/altimate-base` and becomes the free fallback when no paid Altimate Gateway or
68
72
explicit model is selected. Big Pickle is retired as a new selection — it no longer appears in the
69
73
picker or the full model catalog for users choosing a model for the first time. Users already on
70
-
Big Pickle are still detected on launch and offered Altimate Base through the same consent gate.
71
-
If you decline the default switch, `declinedManagedBaseDefault: true` in the state directory's `model.json` keeps public Zen ahead of registered Base for headless and ACP defaults, with Base used only as a last resort; accepting migration or explicitly selecting Base clears the flag.
72
-
73
-
Registration is per machine, not per host. Once any host on a machine has registered Altimate
74
-
Base (the TUI's consent gate, or the HTTP registration route used by IDE integrations), every
75
-
other host on that machine treats Base as the default free model without showing its own
76
-
prompt: the TUI migrates an implicit free default silently, and headless `altimate run`,
77
-
`altimate serve`, and ACP sessions resolve to Base ahead of the keyless public Zen tier. The
78
-
disclosure is therefore shown once per machine, by whichever host registers. Declining as
79
-
described above applies to all hosts on the machine too. Administrators auditing a fleet can
80
-
check `model.json` for `declinedManagedBaseDefault` and the registered `altimate-free` provider
81
-
entry in `auth.json`.
74
+
Big Pickle are migrated to Altimate Base the same automatic way once it registers, not through a
75
+
separate confirmation: `declinedManagedBaseDefault` is still read from `model.json` for backward
76
+
compatibility, but no longer changes the outcome — the keyless public Zen tier rejects
77
+
unauthenticated traffic outright, so there is no longer a working "stay on public Zen" choice to
78
+
honor.
79
+
80
+
To opt out: set `ALTIMATE_BASE_AUTO_REGISTER=0` before this install first registers Base, run
81
+
`altimate providers logout altimate-base` afterward, or keep it out of your own choices with
82
+
`enabled_providers` / `disabled_providers`. The env var is the only one of these that stops the
83
+
background registration call itself; the other two only control whether Base can be *selected* as
84
+
your model on this machine — logging out also un-registers it (it will auto-register again on the
85
+
next launch unless the env var is also set).
86
+
87
+
Registration is per machine, not per host: once any host on a machine has registered Altimate
88
+
Base (auto-registration on any entrypoint, or the HTTP registration route used by IDE
89
+
integrations), every other host on that machine treats Base as the default free model too — the
90
+
TUI migrates an implicit free default silently, and headless `altimate run`, `altimate serve`, and
91
+
ACP sessions resolve to Base ahead of the keyless public Zen tier. Logging out on any host applies
92
+
to all hosts on the machine, since the credential is a single shared file. Administrators auditing
93
+
a fleet can check for the registered `altimate-free` provider entry in `auth.json`.
82
94
83
95
Official release binaries embed the current gateway endpoint at build time. Operators and local
84
96
development can override it without changing code:
Copy file name to clipboardExpand all lines: docs/docs/getting-started/quickstart.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ On a fresh install, a welcome panel appears with a curated 6-provider picker:
25
25
26
26
-**Altimate LLM Gateway***(recommended)* — 10M tokens free, no API keys. Routes to the best model per task across Sonnet, Opus, GPT-5, and more. Sign-in opens a browser tab; complete Google or email signup and you're back in the TUI. If your terminal can't open a browser (SSH / tmux / WSL), the CLI prints the URL — paste it into a browser on your desktop.
27
27
-**Anthropic** / **OpenAI** / **Google** — paste an API key or OAuth in.
28
-
-**Altimate Base** — a hosted open model, free and rate limited, with no signup or API key. Requests and responses may be logged and used to improve Altimate's products, so do not send secrets or confidential code. Registration happens only after an explicit confirmation that defaults to **No**.
28
+
-**Altimate Base** — a hosted open model, free and rate limited, with no signup or API key. Requests and responses may be logged and used to improve Altimate's products, so do not send secrets or confidential code. If you don't pick another provider, a fresh install registers it automatically — there is no confirmation dialog — and prints this notice once. Opt out with `ALTIMATE_BASE_AUTO_REGISTER=0`, `altimate providers logout altimate-base`, or `disabled_providers` (see [providers](../configure/providers.md#altimate-base)).
29
29
-**Search all providers…** — full picker if you need Bedrock, Databricks AI Gateway, Cloudflare AI Gateway, Snowflake Cortex, DigitalOcean Inference, etc.
30
30
31
31
Or set an environment variable and skip the picker:
Copy file name to clipboardExpand all lines: docs/docs/reference/network.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ altimate needs outbound HTTPS access to:
41
41
| Destination | Purpose |
42
42
|-------------|---------|
43
43
| Your LLM provider API | Model inference (Anthropic, OpenAI, etc.) |
44
-
| Official Altimate Base gateway (embedded in release), or the host set by `ALTIMATE_BASE_GATEWAY_URL`| Altimate Base registration and inference when you explicitly enable Altimate Base|
44
+
| Official Altimate Base gateway (embedded in release), or the host set by `ALTIMATE_BASE_GATEWAY_URL`| Altimate Base registration (automatic on a fresh install with no model of its own, unless `ALTIMATE_BASE_AUTO_REGISTER=0`) and inference|
45
45
|`registry.npmjs.org`| Package updates |
46
46
|`models.dev`| Model catalog (can be disabled) |
47
47
| Your warehouse endpoints | Database connections |
Copy file name to clipboardExpand all lines: docs/docs/reference/security-faq.md
+11-6Lines changed: 11 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,11 +13,16 @@ Answers to the most common security questions about running Altimate Code in you
13
13
14
14
Altimate Code sends prompts and context to the LLM provider you configure (Anthropic, OpenAI, Azure OpenAI, AWS Bedrock, etc.). **You choose the provider.** No data is sent anywhere else except optional [telemetry](#what-telemetry-is-collected), which contains no code, queries, or credentials.
15
15
16
-
Altimate Base is an optional hosted provider. Its confirmation dialog explains that requests and
17
-
responses are logged and may be used to improve Altimate products and services; do not send
18
-
secrets or confidential code. The dialog defaults to **No**, and no registration request is made
19
-
unless you explicitly accept. This request logging is part of the Altimate Base service and is
20
-
separate from anonymous product telemetry.
16
+
Altimate Base is Altimate's own hosted free model. A fresh install with no model of its own
17
+
registers it automatically — there is no confirmation dialog to accept. Requests and responses are
18
+
logged and may be used to improve Altimate products and services, including the model; secrets are
19
+
automatically masked before storage, but don't rely on it — avoid sending secrets or confidential
20
+
code. This notice is printed once — a toast in the TUI, or a one-line stderr notice the first time
21
+
a headless entrypoint (`run`, `serve`, `acp`, `web`) registers it — and is part of the Altimate
22
+
Base service, separate from anonymous product telemetry. To opt out: set
23
+
`ALTIMATE_BASE_AUTO_REGISTER=0` before Base ever registers, run `altimate providers logout
24
+
altimate-base` afterward, or exclude it from your own model choices with `enabled_providers` /
25
+
`disabled_providers` (see [providers](../configure/providers.md#altimate-base)).
21
26
22
27
**What identifies you to Altimate Base.** Registration sends a SHA-256 hash of a locally generated
23
28
installation secret — the secret itself never leaves your machine. That hash is stable, so logged
@@ -110,7 +115,7 @@ You can also configure per-agent permissions. For example, restrict the `analyst
110
115
| Destination | Purpose |
111
116
|-------------|---------|
112
117
| Your configured LLM provider | Model inference |
113
-
| Altimate Base gateway | Registration and inference only after you explicitly enable Altimate Base|
118
+
| Altimate Base gateway | Registration (automatic on a fresh install with no model of its own) and inference|
Copy file name to clipboardExpand all lines: docs/docs/reference/telemetry.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,7 +45,7 @@ We collect the following categories of events:
45
45
| `first_launch` | Fired once on the first CLI run after an install or upgrade, triggered by a marker file the installer wrote — the installers themselves send nothing and contact no telemetry endpoint. Contains the installed version, `is_upgrade`, and `install_method` (`curl`, `powershell`, `npm`, `vscode-extension`, `local` for `install --binary`, or `unknown` for markers written before the field existed). `vscode-extension` starts appearing only once an extension build containing the marker write ships, so a zero share for it means the extension has not rolled out yet rather than no extension installs. No PII. **Reading `is_upgrade`:** it means "this machine had run altimate-code before", probed as whether `~/.altimate/machine-id` already existed — *not* "a binary was already present". A reinstall onto a machine that ever ran the CLI reports `is_upgrade: true`, and `altimate uninstall` leaves `machine-id` in place, so a metric excluding upgrades counts installs **per previously-unseen machine** and undercounts reinstalls onto known ones. (`is_upgrade` is a boolean in the event schema; it arrives in Application Insights `customDimensions` as a string, so KQL filters read `tostring(customDimensions.is_upgrade) != "true"`.) Delivery is at-most-once: the marker is deleted before the event flushes, so a process that dies first loses that install rather than re-firing it every launch. Local `--binary` installs report `version: "local"`. |
46
46
|`startup_ready`| Fired once per process when the top-level command can serve its first request or frame (`serve` listening, TUI transport resolved, `run` about to send its first prompt). Contains the command name, `duration_ms` since process start, and `fresh_install` (true when this process also emitted a non-upgrade `first_launch`). No PII. |
47
47
|`event_loop_stall`| A 250 ms monitor tick fired more than 1 s late, meaning the event loop was blocked for that long (for example an in-process dependency install). Contains the command name, `thread` (`main` or `worker`), `blocked_ms`, and `since_start_ms`. Capped at 20 per thread (the main thread and the TUI server worker each keep their own counter). No PII. |
48
-
|`altimate_base_registration`| Timing and outcome of each Altimate Base registration after consent (concurrent calls share one result, and a still-valid cached credential reports `success` without a network round trip): `result` (`success`, `network`, `http`, `response`, `cancelled`, `configuration`, or `error`), `duration_ms`, and the HTTP `status` when the result is `http`. Distinct from `altimate_base_register_result`, which records the onboarding-flow outcome. No gateway URL, response body, credential, or error text is included. |
48
+
|`altimate_base_registration`| Timing and outcome of each Altimate Base registration, whether triggered automatically at startup or by an explicit picker selection (concurrent calls share one result, and a still-valid cached credential reports `success` without a network round trip): `result` (`success`, `network`, `http`, `response`, `cancelled`, `configuration`, or `error`), `duration_ms`, and the HTTP `status` when the result is `http`. Distinct from `altimate_base_register_result`, which records the onboarding-flow outcome. No gateway URL, response body, credential, or error text is included. |
49
49
|`task_outcome_signal`| Behavioral quality signal at session end — accepted, error, abandoned, or cancelled. Includes tool count, step count, duration, and last tool category. No user content. |
50
50
|`task_classified`| Intent classification of the first user message using keyword matching — category (e.g. `debug_dbt`, `write_sql`, `optimize_query`), confidence score, and detected warehouse type. No user text is sent — only the classified category. |
51
51
|`tool_chain_outcome`| Aggregated tool execution sequence at session end — ordered tool names (capped at 50), error count, recovery count, final outcome, duration, and cost. No tool arguments or outputs. |
@@ -55,10 +55,10 @@ We collect the following categories of events:
55
55
|`validator_check`| A completion-gate validator ran on session end — validator name, `ok` boolean, step, retry count, `enforced` flag (false in shadow mode), and structured `details` (model counts, elapsed time, concurrency limit — no SQL or model content). Only emitted when `ALTIMATE_VALIDATORS_ENABLED=1` or `ALTIMATE_VALIDATORS_SHADOW=1`. See [Validators](../data-engineering/validators.md). |
56
56
|`validator_retries_exhausted`| A session terminated with unresolved validator failures after exhausting the synthetic-retry budget — names of the failing validators (no failure body content). |
57
57
|`onboarding_started`| The first-run setup gate opened (fresh launch with no usable model). |
58
-
|`model_picker_shown`| The provider picker was displayed. `trigger` distinguishes the first run from `/connect`, from declining Altimate Base, and from the prompt gate. |
58
+
|`model_picker_shown`| The provider picker was displayed. `trigger` distinguishes the first run from `/connect` and from the prompt gate (`altimate_base_back` is defined in the schema but no longer emitted — it recorded backing out of the old consent dialog, which no longer exists). |
59
59
|`provider_selected`| A provider row was chosen — `altimate_gateway`, `altimate_base`, `anthropic`, `openai`, `google`, `search_all`, or `other` for anything outside the curated five. `provider_id` carries the raw id only for publicly-known providers, so a provider you named yourself in config is reported as `other` with no name attached. `via_search` marks a pick made inside the full catalogue after choosing "Search all providers…". **Choosing search emits this event twice for one user** — once as `search_all`, then again with the provider actually chosen — so count distinct users or filter on `via_search`, not raw event count. Recorded at the moment of choice, so a sign-in that is then cancelled still counts. |
60
-
|`altimate_base_confirm_shown` / `altimate_base_choice`|The Altimate Base disclosure was shown, and what the user decided (`accept`/`cancel`). `origin` is `welcome`, `model`, or `migration` (returning free-default users offered Altimate Base on launch); required for the disclosure event and optional for the choice event. |
61
-
|`altimate_base_register_result`| The consented registration outcome: `success`, `rate_limited`, `unavailable`, `network`, or `error`. Optional `origin` is `welcome`, `model`, or `migration` (returning free-default users offered Altimate Base on launch). No credential or gateway response body is included. |
60
+
|`altimate_base_confirm_shown` / `altimate_base_choice`|Legacy — defined in the event schema but no longer emitted. These recorded the old consent dialog (shown, then `accept`/`cancel`), removed once Altimate Base moved to auto-registration with no confirmation step. |
61
+
|`altimate_base_register_result`| The registration outcome from a picker-driven selection (the welcome picker, the full catalogue, or the provider dialog): `success`, `rate_limited`, `unavailable`, `network`, or `error`. Optional `origin` is `welcome`, `model`, or `migration` (returning free-default users offered Altimate Base). Auto-registration at startup is reported separately, by `altimate_base_registration` above. No credential or gateway response body is included. |
62
62
|`gateway_device_code_issued`| The Altimate Gateway authorize URL was built and the browser open attempted. **Name note:** the flow is a browser loopback OAuth — there is no device code. The name follows the original event spec. |
63
63
|`gateway_auth_completed` / `gateway_auth_failed`| Gateway sign-in outcome. `reason` is `timeout`, `denied`, or `error` — never the underlying message, which can contain the instance name. An unrecognised callback state does not reject the pending attempt, so a CSRF mismatch surfaces as `timeout`. |
64
64
|`instance_connected`| Credentials received and saved. `time_to_connect_ms` runs from the start of the authorize call, so it includes the browser launch. No instance or tenant name is sent. |
0 commit comments