arcmira 0.1.3 → 0.3.0

package/LICENSE

@@ -1,7 +1,202 @@
-Copyright (c) 2026 Arcmira. All rights reserved.
 
-This software is proprietary. No license is granted to copy, modify,
-distribute, or create derivative works, except as needed to install
-and use the published npm package in your own applications.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND.
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,20 +1,249 @@
-# Arcmira
+# Arcmira for TypeScript and JavaScript
 
-Arcmira is an SF-based AI company and the search engine for the spoken web.
+The official `arcmira` package: a typed client for the [Arcmira API](https://arcmira.com/docs) and the `arcmira` command line. Arcmira is the search engine for the spoken web: it indexes YouTube and podcast transcripts and answers who said what, where, and when.
 
-This package is the official npm name for Arcmira. It exports public URLs. It is not an SDK.
+- Zero runtime dependencies. Uses the global `fetch`, so it runs in Node 18 and later, Cloudflare Workers, Deno, Bun and browsers.
+- ESM and CommonJS builds with types.
+- Every list pages itself. Every error is a typed class carrying the parsed API body.
+- Full API scope: search, transcripts (reading and ordering them), mentions, momentum, sponsors and recommendations, monitors, trackers, team, corrections and feedback.
 
-```js
-const arcmira = require("arcmira")
-// arcmira.apiBase === "https://api.arcmira.com/v1"
+## Install
+
+```sh
+npm install arcmira
+```
+
+To give your coding agent Arcmira, run setup. It finds Claude Code, Codex, Cursor, VS Code, Gemini CLI and Claude Desktop, adds the [Arcmira MCP server](https://github.com/arcmira/mcp) to each, installs the Arcmira skills, and turns updates on. Arcmira ships changes weekly, so keep them on:
+
+```sh
+npx arcmira setup --dry-run   # print what would change
+npx arcmira setup             # apply, then sign in once per agent
+```
+
+Get a key at [arcmira.com/docs/authentication](https://arcmira.com/docs/authentication) and set `ARCMIRA_API_KEY`, or pass `apiKey` to the client.
+
+## Premium quickstart
+
+```ts
+import { ArcmiraClient } from "arcmira";
+const arcmira = new ArcmiraClient();
+const transcript = await arcmira.transcripts.prepareAndWait({ video_id: "dQw4w9WgXcQ" });
+for (const line of transcript.lines ?? []) console.log(line.speaker, line.text);
+```
+
+`prepareAndWait({ video_id, maxOnDemandCents = 0, timeoutSeconds = 300 })` reads the Premium transcript and returns it. When your account does not own it yet, the call posts `{ video_id }` to `/v1/transcriptions` once, polls the job at the pace the API sets with `Retry-After` and `next_poll_seconds`, and reads the finished transcript. The default spends included credits only and sends no `Idempotency-Key`. Preparation buys the whole video, even if you later read a window.
+
+Errors you can handle:
+
+- `PreparationTimeoutError` when the job outlasts `timeoutSeconds`. It carries `job`, and the job keeps running.
+- `PreparationFailedError` when the job fails or is refunded. It carries `job`.
+- `PremiumUnavailableError` when the plan has no Premium. The read returned captions, which are never returned as Premium.
+- `ArcmiraError` subclasses for any API refusal, such as `quota_exceeded`, with the API's error object in `body`.
+
+To spend money, pass a cents ceiling you have approved: `prepareAndWait({ video_id, maxOnDemandCents: 25 })`. The call then sends the quoted `max_rows` and one generated `Idempotency-Key`, which the SDK's retries reuse.
+
+## Quickstart
+
+```ts
+import { Arcmira, ArcmiraClient } from "arcmira";
+
+const client = new ArcmiraClient({ apiKey: process.env.ARCMIRA_API_KEY });
+
+// Who is "Ramp"? Filters take ids, so resolve the name first. The answer is best (one row is meant),
+// suggested (one row stands out: use it and say you assumed it), or ask (show the options to the user).
+// context carries the user's own words about the name and settles close calls.
+const resolved = await client.entities.resolve({ q: "Ramp", context: "the corporate card company" });
+const ramp = resolved.best ?? resolved.suggested;
+if (!ramp) throw new Error(resolved.ask ? `${resolved.ask.question} ${resolved.ask.options.map((o) => o.label).join("; ")}` : "no match");
+if (resolved.suggested) console.log(`Assuming ${ramp.name} (${ramp.type}): ${resolved.suggested.evidence}`);
+console.log(ramp.id, ramp.type, ramp.page);
+
+// Spoken slices that answer a phrase. about, by and channel_ids take ids only; a name answers 400 id_required.
+const hits = await client.transcripts.search({ q: "corporate cards", about: ramp.id, kind: "recommendation_sponsored", limit: 5 });
+for (const chunk of hits.chunks) console.log(chunk.channelName, chunk.publishedAt, chunk.watchUrl, chunk.text);
+// The plan window and index state come back with every search: say where the results stop.
+if (hits.filters.publishedBefore) console.log(`results stop before ${hits.filters.publishedBefore}`);
+if (hits.search_index.missing_before) console.log(`transcripts before ${hits.search_index.missing_before} are still being added`);
+
+// Catalog rows page themselves: iterate and the client follows next_cursor. Each row bills, so stop when you have enough.
+let seen = 0;
+for await (const mention of await client.mentions.list({ entity_id: ramp.id, limit: 25 })) {
+    console.log(mention.media.title, mention.start_seconds);
+    if (++seen === 40) break;
+}
+
+// Gates and failures are typed. The body is the API's error object.
+try {
+    const momentum = await client.entities.momentum({ id: ramp.id });
+    console.log(momentum.verdict, momentum.volume);
+} catch (err) {
+    if (err instanceof Arcmira.PaymentRequiredError) console.log(err.body.error.gate, err.body.error.unlock?.url);
+    else throw err;
+}
+```
+
+To prepare Premium without waiting, read it, post the purchase, and poll the job yourself. GET never buys, and each state is typed. Every purchase answers one `TranscriptJob`. Without an `Idempotency-Key`, a purchase already open or owned for the video comes back with `existing: true`. A positive `max_on_demand_cents` requires both `Idempotency-Key` and `max_rows`.
+
+```ts
+const read = await client.transcripts.get({ video_id: "dQw4w9WgXcQ", quality: "premium" });
+if (read.state === "preparation_required") {
+    const { job } = await client.transcripts.request({ video_id: read.video_id });
+    console.log(job.state, job.next_poll_seconds, job.status_url);
+}
+for await (const job of await client.transcripts.listRequests({ limit: 10 })) console.log(job.id, job.state);
+```
+
+Every method is listed with its request and response types in [reference.md](./reference.md). The same operations, with `curl` samples, are in the [API reference](https://arcmira.com/docs/api-reference).
+
+### Pagination
+
+A method that returns a `Page` is an async iterable over rows. `page.data` holds the current rows, `page.response` the raw list response (`has_more`, `next_cursor`), and `page.hasNextPage()` / `page.getNextPage()` walk it by hand.
+
+### Errors
+
+Every non-2xx answer throws a subclass of `ArcmiraError` named for the status: `BadRequestError`, `UnauthorizedError`, `PaymentRequiredError`, `ForbiddenError`, `NotFoundError`, `ConflictError`, `TooManyRequestsError`, `InternalServerError` and so on, all under the `Arcmira` namespace. `err.statusCode` is the status and `err.body.error` is the API's error object: `type`, `code`, `message`, `doc_url`, `request_id`, and on a plan gate `gate` and `unlock.url`. Switch on `type` and `gate` first; `code` is a string whose catalog is in the [errors page](https://arcmira.com/docs/errors).
+
+### Options
+
+`new ArcmiraClient({ apiKey, baseUrl, timeoutInSeconds, maxRetries, headers, fetch })`. `apiKey` falls back to `ARCMIRA_API_KEY`. On Cloudflare Workers pass `apiKey` from your binding; the environment fallback reads `process.env`, which exists there only with `nodejs_compat`.
+
+## Command line
+
+The package ships the `arcmira` binary. Its data commands mirror the tools of the [Arcmira MCP server](https://github.com/arcmira/mcp), so a workflow you prototype with an agent runs the same from a shell.
+
+```sh
+npx arcmira login you@example.com                 # emails a six digit code
+npx arcmira login you@example.com --code 482913   # saves the key; later commands need no ARCMIRA_API_KEY
+npx arcmira whoami
+npx arcmira resolve Ramp
+npx arcmira search "agent payments" --limit 3
+npx arcmira sponsors TBPN
+npx arcmira api GET /v1/mentions -f entity_id=ent_14 --paginate
 ```
 
-- Product: https://arcmira.com
+### Setup
+
+`arcmira setup` connects `https://mcp.arcmira.com/mcp` and installs the Arcmira skills in each agent it finds: `arcmira` (the client reference) plus one skill per task (`sponsor-research`, `company-watch`, `find-quotes`, `person-research`, `compare-shows`).
+
+| Agent | MCP server | Skills | Updates |
+| --- | --- | --- | --- |
+| Claude Code | the `arcmira` plugin: `claude plugin marketplace add arcmira/mcp`, `claude plugin install arcmira@arcmira` | in the plugin | auto-update on: `autoUpdate: true` on `extraKnownMarketplaces.arcmira` in `~/.claude/settings.json` |
+| Codex | `codex mcp add arcmira --url ...` | `~/.agents/skills/<name>/SKILL.md` | refreshed by a newer `arcmira` |
+| Cursor | `~/.cursor/mcp.json` | `~/.cursor/skills/<name>/SKILL.md` | refreshed by a newer `arcmira` |
+| VS Code | the user profile's `mcp.json` | `~/.copilot/skills/<name>/SKILL.md` | refreshed by a newer `arcmira` |
+| Gemini CLI | `~/.gemini/settings.json` | `~/.gemini/skills/<name>/SKILL.md` | refreshed by a newer `arcmira` |
+| Claude Desktop | printed steps (Customize, then Connectors) | printed steps (a skill upload) | the connector is remote |
+
+- Idempotent: an agent that already has the server is left alone, and a second run prints `unchanged` for every line.
+- `--auth oauth` (default) leaves sign-in to each agent, in the browser. `--auth key` sends the key in use as a bearer header instead; Codex reads it from `ARCMIRA_API_KEY`. The key is never printed. With `--auth key`, Claude Code gets `claude mcp add --header ...` and skill copies instead of the plugin, because a plugin's server entry cannot carry your key.
+- `--only <agent>` (repeatable) limits the run, `--dry-run` changes nothing, `--yes` skips the confirmation. Without a key and at a terminal, setup offers the `arcmira login` email flow first.
+- A JSON config that is not plain JSON (comments, trailing commas) is not rewritten; setup prints the entry to add by hand.
+
+### Updates
+
+Arcmira changes weekly. Three parts keep you current:
+
+- **The MCP server** is remote. Every client fetches its tools and instructions on connect, and `describe` returns the reference from the server on every call, so the MCP server alone is always current.
+- **The Claude Code plugin** updates in the background once auto-update is on. `arcmira setup` turns it on. By hand: run `/plugin`, open **Marketplaces**, pick `arcmira`, and choose **Enable auto-update**. Update now: `claude plugin update arcmira@arcmira`.
+- **Skill copies and this CLI.** `arcmira` checks npm for a newer version at most once a day and prints one line when there is one (`ARCMIRA_NO_UPDATE_CHECK=1` or `CI` turns the check off). Update with `npm i -g arcmira@latest`. The first command the new version runs rewrites every skill directory setup used (recorded in `~/.config/arcmira/setup.json`), adding skills that are new in that version.
+
+`arcmira examples` prints worked tasks: resolve a name, check the row, then filter by its id.
+
+### Commands
+
+```text
+Data commands (they mirror the MCP tools)
+  arcmira search <query>              spoken transcript slices for a topic or phrase; --about, --by (ids) and --kind filter them
+  arcmira resolve <name>              a name to one entity id: the best match, an assumed pick, or options; --context settles close calls
+  arcmira mentions --entity <id|name> where an entity was mentioned, newest first
+  arcmira momentum <id|name>...       7 and 30 day volume for one to four entities
+  arcmira sponsors <channel>          recurring sponsors of a YouTube channel
+  arcmira recommendations <id|name>   who recommends an entity on air, paid or organic
+  arcmira episodes <channel>          newest indexed videos of a channel
+  arcmira transcripts get <video>     full transcript of one YouTube video
+  arcmira transcripts quote <video>   free whole-video quote
+  arcmira transcripts request <video> --max-rows N --idempotency-key KEY [--max-on-demand-cents N]
+  arcmira transcripts status <id>     state of a transcript request, with the next poll time
+  arcmira occurrences --channel ...   ranked counts of the entities a set of channels or videos mention
+  arcmira status [channel]            your plan, or a channel's coverage
+
+Aliases
+  arcmira transcript <video>          same as arcmira transcripts get (the MCP tool get_transcript)
+
+Account
+  arcmira setup [--only agent]        connect the MCP server and skills to your coding agents, updates on
+  arcmira login [email] [--code N] [--key arc_sk_...]
+  arcmira logout
+  arcmira whoami                      key id, label and account, plan, scopes, rate limit, rows, and where the key came from
+  arcmira auth login                  same as arcmira login
+  arcmira auth logout                 same as arcmira logout
+  arcmira auth status                 same as arcmira whoami
+  arcmira auth token [--reveal]       the key in use, masked unless --reveal
+
+Any endpoint
+  arcmira api <method> <path>         -f key=value, -F key=value|@file, -H 'Name: value', --body @file|-, --paginate, --verbose
+  arcmira schema [command|operationId] method, path, parameters and body fields, offline
+  arcmira docs [query]                search the docs, or print their address
+  arcmira examples                    worked examples, resolve first then filter by id
+
+Not available yet (each prints the arcmira api call that does the same, and exits 2)
+  arcmira monitors, arcmira trackers, arcmira corrections, arcmira feedback, arcmira keys
+
+Also: arcmira help [command], --help, --version
+```
+
+Commands that take an `ent_` or `UC` id also take a name or `@handle`; the CLI resolves it first (one extra call to `GET /v1/entities/resolve`) and says what it picked on stderr. A suggested pick is used and stated as an assumption with its reason. An ambiguous name exits 2 and lists the options with their ids.
+
+`arcmira transcripts get <video> --quality premium --wait` reads Premium, prepares it from included credits when your account does not own it yet (one keyless `POST /v1/transcriptions`, no money moves), waits for the job, and prints the transcript. `--timeout S` bounds the wait (default 300). Without `--wait`, a read never buys: when Premium needs preparing, the CLI exits 3 and prints the `--wait` command to run on stderr, and a job still running exits 4. With `--json` the API body is still printed on stdout, so `arcmira transcripts get X --quality premium --json | jq` fails on the exit code under `set -o pipefail`.
+
+`arcmira transcripts request` posts the same keyless purchase without waiting and prints the job. To spend on-demand money, pass the cents you approve with `--max-on-demand-cents`, plus `--max-rows` and a previously saved `--idempotency-key`; retry an unknown response with the same key and identical input. Whole-video pricing applies even when you later read a small window.
+
+`arcmira api` follows `gh api`: `-f` adds a string parameter and `-F` a typed one (`true`, `false`, `null`, numbers, `@file`, `key[]=value`). They go to the query string on GET and DELETE, and into a JSON body otherwise. For `POST /v1/transcriptions`, pass your saved key with `-H 'Idempotency-Key: ...'`. Other POST requests generate a key when none is supplied; `--verbose` shows it. Reuse the same key and input to retry a write. The path may drop the `/v1` prefix.
+
+- Key: `--key`, then `ARCMIRA_API_KEY`, then the key `arcmira login` saved in `~/.config/arcmira/config.json` (mode 0600; `XDG_CONFIG_HOME` is honored). `arcmira login --key arc_sk_...` saves a key you already have; `arcmira logout` deletes it.
+- Output: data on stdout, notes and errors on stderr, no colour. `--json` prints the API response unchanged on stdout; on failure it prints `{"error":{"type","code","message","request_id",...}}` on stderr, the API's own error body or a `usage_error` in the same shape.
+- Errors: every API error names its `request_id` (quote it to support). A 401 adds `try: arcmira login`.
+- Paging: `mentions` and `recommendations` take `--cursor`; the next page's command is printed on stderr, and `next_cursor` is in `--json`. `arcmira api --paginate` follows every page.
+- Exit codes: 0 ok, 1 an API or network error (the message names the code and any unlock link), 2 a usage error (bad input, no key, an unresolved name, a command or flag not available yet), 3 Premium needs preparing (stderr names the `--wait` command), 4 Premium is still pending (the job keeps running; run the same command again). Input is checked before any request.
+- Reserved flags: `--dry-run`, `--force`, `-y`/`--yes`, `--profile` and `--jq` exit 2 in this version outside `arcmira setup`; their names are held for write commands to come.
+- Requests carry `User-Agent: arcmira-cli/<version>`. The SDK used on its own sends `arcmira/<version>`.
+- Telemetry: none. The CLI sends only the API requests you ask for, plus a docs search when you run `arcmira docs <query>`.
+- Environment: `ARCMIRA_API_KEY`, `ARCMIRA_BASE_URL` (API origin), `ARCMIRA_DOCS_URL` (docs origin, for tests), `XDG_CONFIG_HOME`, `NO_COLOR`.
+
+`arcmira <command> --help` lists each option with examples. `scripts/cli-audit/conformance.mjs` scores every command against a local fake of the API.
+
+## Links
+
 - Docs: https://arcmira.com/docs
-- HTTP API: https://api.arcmira.com/v1
-- Agent index: https://arcmira.com/llms.txt (this repo also has `llms.txt`, which points there)
-- Source: https://github.com/arcmira/arcmira
+- API reference: https://arcmira.com/docs/api-reference
+- Python SDK: https://github.com/arcmira/python (`pip install arcmira`)
+- MCP server for agents: https://github.com/arcmira/mcp, what it does: https://arcmira.com/mcp
+- Developers page: https://arcmira.com/developers
+- Agent index: https://arcmira.com/llms.txt
+
+## Development
+
+`src/` is generated from the Arcmira OpenAPI document by [Fern](https://github.com/fern-api/fern); do not edit it by hand, a regeneration overwrites it. The one exception is `src/wrapper/`, which holds `transcripts.prepareAndWait`; the installer keeps it and points `src/index.ts` at its `ArcmiraClient`. `cli/`, `tests/` and this file are hand-written. `npm test` builds and runs the tests against a local fake of the API (`tests/fake-v1.mjs`, bodies in `tests/fixtures/v1.json`).
 
-The official MCP server is [arcmira/mcp](https://github.com/arcmira/mcp). What it does: https://arcmira.com/mcp. Setup for each host: https://arcmira.com/agent-setup.
+## License
 
-Copyright Arcmira. All rights reserved. See `LICENSE`.
+Apache-2.0. See [LICENSE](./LICENSE).
+
+## Regenerate the SDK
+
+Run `npm run generate -- <path to arcmira-v1.json>` with Node 22 or newer, Python 3, Docker, and Fern access for the `arcmira` organization. It vendors the spec into `fern/openapi.json` (omit the path to reuse the vendored copy), pins Fern CLI 5.131.1 and TypeScript generator 3.96.0, disables CLI version redirection and telemetry, and regenerates `src/`, `reference.md` and `cli/operations.ts`.
+
+The overlay combines success schemas into a `state` union, preserves existing method names, and discovers cursor collections from their schemas. Unknown or ambiguous collections fail generation. An exact checked patch keeps request timer cleanup in `finally` until the pinned generator includes the fix. Generated source is never edited by hand.
+
+Run `npm test` for the SDK and CLI tests, and `npm run test:types` for the consumer type contract. Tests use local HTTP fixtures and do not purchase transcripts.
+
+## Migrate from 0.2
+
+`transcripts.get` returns `TranscriptResult`. Narrow on `state` before accessing transcript lines. Use `.withRawResponse()` for HTTP status and headers. `transcripts.request` takes `video_id` and answers `{ job, existing }`. `channels.videos.list` and `transcripts.listRequests` return pages: iterate them with `for await`, or read `page.response` for the list body. See [CHANGELOG.md](./CHANGELOG.md).
+
+```ts
+const { data, rawResponse } = await client.transcripts.get({ video_id: "dQw4w9WgXcQ", quality: "premium" }).withRawResponse();
+if (data.state === "ready") console.log(data.lines);
+else if (data.state === "pending") console.log(data.job.status_url, data.job.next_poll_seconds, rawResponse.status);
+else console.log(data.quote, data.action);
+```

package/dist/cjs/BaseClient.d.ts

@@ -0,0 +1,54 @@
+import { BearerAuthProvider } from "./auth/BearerAuthProvider.js";
+import * as core from "./core/index.js";
+import type * as environments from "./environments.js";
+export type AuthOption = false | core.AuthProvider["getAuthRequest"] | core.AuthProvider | BearerAuthProvider.AuthOptions;
+export type BaseClientOptions = {
+    environment?: core.Supplier<environments.ArcmiraEnvironment | string>;
+    /** Specify a custom URL to connect the client to. */
+    baseUrl?: core.Supplier<string>;
+    /** Additional headers to include in requests. */
+    headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    /** The default maximum time to wait for a response in seconds. */
+    timeoutInSeconds?: number;
+    /** The default number of times to retry the request. Defaults to 2. */
+    maxRetries?: number;
+    /** Provide a custom fetch implementation. Useful for platforms that don't have a built-in fetch or need a custom implementation. */
+    fetch?: typeof fetch;
+    /** Configure logging for the client. */
+    logging?: core.logging.LogConfig | core.logging.Logger;
+    /** Default options for SSE stream reconnection behavior. Has no effect on non-resumable endpoints. */
+    stream?: {
+        reconnectionEnabled?: boolean;
+        maxReconnectionAttempts?: number;
+    };
+    /** Override auth. Pass false to disable, a function returning auth headers, an AuthProvider, or auth options. */
+    auth?: AuthOption;
+} & BearerAuthProvider.AuthOptions;
+export interface BaseRequestOptions {
+    /** The maximum time to wait for a response in seconds. */
+    timeoutInSeconds?: number;
+    /** The number of times to retry the request. Defaults to 2. */
+    maxRetries?: number;
+    /** A hook to abort the request. */
+    abortSignal?: AbortSignal;
+    /** Additional query string parameters to include in the request. */
+    queryParams?: Record<string, unknown>;
+    /** A dictionary containing additional parameters to spread into the request's body. */
+    additionalBodyParameters?: Record<string, unknown>;
+    /** Additional headers to include in the request. */
+    headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    /** Options for SSE stream reconnection behavior. Has no effect on non-resumable endpoints. */
+    stream?: {
+        reconnectionEnabled?: boolean;
+        maxReconnectionAttempts?: number;
+    };
+}
+export type NormalizedClientOptions<T extends BaseClientOptions = BaseClientOptions> = T & {
+    logging: core.logging.Logger;
+    authProvider?: core.AuthProvider;
+};
+export type NormalizedClientOptionsWithAuth<T extends BaseClientOptions = BaseClientOptions> = NormalizedClientOptions<T> & {
+    authProvider: core.AuthProvider;
+};
+export declare function normalizeClientOptions<T extends BaseClientOptions = BaseClientOptions>(options: T): NormalizedClientOptions<T>;
+export declare function normalizeClientOptionsWithAuth<T extends BaseClientOptions = BaseClientOptions>(options: T): NormalizedClientOptionsWithAuth<T>;

package/dist/cjs/BaseClient.js

@@ -0,0 +1,77 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeClientOptions = normalizeClientOptions;
+exports.normalizeClientOptionsWithAuth = normalizeClientOptionsWithAuth;
+const BearerAuthProvider_js_1 = require("./auth/BearerAuthProvider.js");
+const headers_js_1 = require("./core/headers.js");
+const core = __importStar(require("./core/index.js"));
+function normalizeClientOptions(options) {
+    const headers = (0, headers_js_1.mergeHeaders)({
+        "X-Fern-Language": "JavaScript",
+        "X-Fern-SDK-Name": "arcmira",
+        "X-Fern-SDK-Version": "0.3.0",
+        "User-Agent": "arcmira/0.3.0",
+        "X-Fern-Runtime": core.RUNTIME.type,
+        "X-Fern-Runtime-Version": core.RUNTIME.version,
+    }, options === null || options === void 0 ? void 0 : options.headers);
+    return Object.assign(Object.assign({}, options), { logging: core.logging.createLogger(options === null || options === void 0 ? void 0 : options.logging), headers });
+}
+function normalizeClientOptionsWithAuth(options) {
+    var _a;
+    const normalized = normalizeClientOptions(options);
+    if (options.auth === false) {
+        normalized.authProvider = new core.NoOpAuthProvider();
+        return normalized;
+    }
+    if (options.auth != null) {
+        if (typeof options.auth === "function") {
+            normalized.authProvider = { getAuthRequest: options.auth };
+            return normalized;
+        }
+        if (core.isAuthProvider(options.auth)) {
+            normalized.authProvider = options.auth;
+            return normalized;
+        }
+        Object.assign(normalized, options.auth);
+    }
+    const normalizedWithNoOpAuthProvider = withNoOpAuthProvider(normalized);
+    (_a = normalized.authProvider) !== null && _a !== void 0 ? _a : (normalized.authProvider = new BearerAuthProvider_js_1.BearerAuthProvider(normalizedWithNoOpAuthProvider));
+    return normalized;
+}
+function withNoOpAuthProvider(options) {
+    return Object.assign(Object.assign({}, options), { authProvider: new core.NoOpAuthProvider() });
+}