fullsendai 0.0.0-stage → 0.2.0

package/README.md

@@ -1,3 +1,70 @@
-# Temporary Holding Version
+# fullsendai
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Connect your coding tools to [FullsendAI](https://fullsendai.com) in one command.
+
+```sh
+npx fullsendai connect
+```
+
+It finds the tools on your computer, signs you in through the browser, lets you pick the model (FullsendAI's own
+Nefarian and Sulfuras first), gives each tool its own API key, writes each tool's settings, and makes a real test call
+through each one. When a model's provider goes down, a backup provider answers, so your tools keep working. Your existing settings, comments and other providers
+are kept, and a backup is made before anything changes.
+
+Works on macOS, Linux and Windows (PowerShell, cmd, Windows Terminal, WSL), with Node.js 18.17 or newer.
+
+## Tools
+
+| Tool | What gets changed |
+| --- | --- |
+| Claude Code | `~/.claude/settings.json`, the `env` block |
+| Codex CLI | `~/.codex/config.toml`, a `fullsend` provider and the model |
+| OpenCode | `~/.config/opencode/opencode.json(c)`, a `fullsend` provider |
+| Kilo Code CLI | `~/.config/kilo/kilo.json`, a `fullsend` provider |
+| Aider | `~/.aider.conf.yml` |
+| Continue | `~/.continue/config.yaml` (or `CONTINUE_GLOBAL_DIR`), FullsendAI's models added first |
+| Cline (command line) | `~/.cline/data/settings/providers.json`, through Cline's own `cline auth` |
+| Cline and Roo Code (VS Code), Cursor | These keep settings inside the editor; you get the exact values and the key to paste |
+
+Each tool is also told what the models can do, so it uses them fully: the context window (so Claude Code and Codex
+don't compact early), the output limit, whether a model reads images, reasons and calls tools, and its prices (so
+OpenCode and Aider show what a session costs).
+
+`CLAUDE_CONFIG_DIR`, `CODEX_HOME` and `XDG_CONFIG_HOME` are respected.
+
+## Always current
+
+Nothing about FullsendAI's models is built into this package: it reads them from the API every time. When a model is
+added, renamed or given new abilities or prices, `status` and `doctor` notice and offer to update your tools, and
+`npx fullsendai sync` does it. A tool whose model was renamed follows it to its new ID; one whose model was removed
+moves to the recommended model, and says so.
+
+## Commands
+
+```sh
+npx fullsendai connect              # find tools, sign in, connect (the default)
+npx fullsendai status               # each tool's model and spend this month, and calls a backup provider answered
+npx fullsendai model                # switch every connected tool to another model (or name it: model sulfuras)
+npx fullsendai doctor --fix         # check settings, keys and a real request; repair settings
+npx fullsendai sync                 # update every tool with FullsendAI's current models, abilities and prices
+npx fullsendai key codex            # copy a tool's key to the clipboard (--show prints it)
+npx fullsendai disconnect           # put each tool's settings back and revoke the keys it made
+```
+
+Options: `--tools claude-code,codex` · `--model <id>` · `--key fs_live_…` (no browser: servers, CI, SSH; a key you give is never revoked) · `--yes` ·
+`--dry-run` · `--keep-keys` · `--json`.
+
+## Where things are kept
+
+`~/.fullsendai/state.json` holds what was connected and each tool's key, readable only by you. Backups of every file
+changed are in `~/.fullsendai/backups/`. Each key shows on your
+[API keys page](https://fullsendai.com/dashboard/keys) named after the tool and this computer, and can be revoked there.
+
+## Environment
+
+| Variable | Use |
+| --- | --- |
+| `FULLSENDAI_API_KEY` | A key to use instead of signing in |
+| `FULLSENDAI_NO_BROWSER` | Print the sign-in address instead of opening a browser |
+| `FULLSENDAI_HOME` | Where state and backups are kept (default `~/.fullsendai`) |
+| `NO_COLOR` | Plain output |