free-pi-cli 0.6.11 → 0.6.12

package/README.md

@@ -1,55 +1,70 @@
 # free-pi-cli
 
-A preconfigured [pi](https://github.com/earendil-works/pi) coding agent, free
-for the user because ads pay for inference. All model calls route through the
-free-pi proxy — you never handle a model API key.
+**A free AI coding agent for your terminal.**
+
+free-pi runs the [pi](https://github.com/earendil-works/pi) coding agent with free model access. Ads shown in the terminal and a daily free allowance pay for it, and you never handle a model API key.
+
+## Install and run
 
 ```
 npx free-pi-cli@latest
 ```
 
-First run shows a consent screen (free inference, ads pay for it, sessions
-may be used to train models), then signs you in with GitHub. Config and the
-signed-in token live under `~/.free-pi/agent`, kept separate from any
-existing `~/.pi/agent` install.
+Or install it once and run it by name:
+
+```
+npm install -g free-pi-cli
+free-pi-cli
+```
 
-## Running it again
+Requires Node 22.19 or newer. The command is `free-pi-cli`, not `pi`.
 
-Closed the terminal? Just run the same command again — you stay signed in:
+## Usage
 
 ```
+cd your-project
 npx free-pi-cli@latest
 ```
 
-Prefer a shorter command? Install it once, globally, then call it by name:
+On first run you accept the terms and sign in with GitHub. Then describe what you want in plain English, and the agent reads, edits and runs code in the current folder.
 
-```
-npm install -g free-pi-cli
-free-pi-cli
-```
+Run it again the same way and you stay signed in. In a folder with a recent session, `--continue` resumes the last session, `--new` starts fresh, and `--session <id>` resumes a specific one. Settings and your sign-in live in `~/.free-pi/agent`, separate from any existing `~/.pi/agent`.
+
+## Why free-pi?
+
+- **Free to start.** Sign in with GitHub and get a daily free allowance. `/usage` shows what is left, and you can buy credits with `/buy-credits` if you want more.
+- **Many models.** Pick one with `/model`, including DeepSeek, GPT, Claude, GLM, Kimi, Qwen and others. See the FAQ for the list.
+- **Free web search and documentation lookup.** The agent can search the web and look up current library documentation. Both count against your allowance.
+- **Bring your sessions with you.** `/import` continues a Claude Code or Codex session in free-pi, or start with `free-pi-cli --import`. It asks before sending anything and removes secrets on your machine first.
+- **Extend it.** Add your own MCP servers with `free-pi-cli mcp add`, use bundled skills, and let the agent track multi-step work with a todo list (`/todos`).
+- **Invite friends.** `/invite` gives you a link, and referrals earn bonus credits (`/referrals`).
+
+## FAQ
+
+### How is it free?
+
+Ads shown in the terminal and a daily free allowance cover the cost of the models. When you use up the allowance you can wait for the next day or buy credits.
+
+### What models are available?
+
+The list changes. Run `/model` to see what you can use right now. Examples at the time of writing: DeepSeek V4 Flash, DeepSeek V4 Pro, DeepSeek V4.1 Flash, Claude Haiku 5.5, GPT-6 Luna, GPT-6.1 Terra, GPT-OSS 120B, GLM 5.3 Flash, Kimi K3.1 Pro, MiMo V2.6 Flash, Qwen3.5 35B, Solar Pro 4 and Muse Spark Open. Larger models use your daily allowance faster.
+
+### Where is it available?
+
+Most countries. free-pi is not available in Iran, Cuba, North Korea or Syria because of US sanctions rules. We may also limit the free allowance in some regions.
+
+### Is my data used to train AI?
+
+free-pi may use your sessions to improve and train models. See the privacy policy at https://freepi.ai/privacy for details, and don't use free-pi for code or data you aren't allowed to share.
+
+### Does it read files outside my project?
+
+The agent can read files anywhere your user account can, but it only reads what your request needs. Project settings and extensions in a folder load only after you trust that folder.
+
+## Links
 
-Note: `free-pi-cli` is the command — **not** `pi`. If you see the built-in
-agent suggest `pi --session …` on exit, use `npx free-pi-cli@latest --session <id>`
-instead. In a folder with a recent session, some users are offered a
-one-keypress continue (default Yes). `--continue` resumes the last session
-here; `--new` starts fresh.
-
-## Development
-
-- `FREEPI_BASE_URL` overrides the backend base URL (default
-  `https://api.freepi.ai`) — point it at a local dev server.
-- `bun test` runs the test suite against an in-process stub server; no real
-  network or real pi TUI involved.
-
-## Layout
-
-| File | Purpose |
-|---|---|
-| `src/index.ts` | bin entry — wires real dependencies, calls `run()` |
-| `src/run.ts` | orchestration: consent → login → token check → launch |
-| `src/consent.ts` | consent screen text/parsing |
-| `src/auth-flow.ts` | Sign-in clients: browser "Connect this terminal" (`/auth/connect/start`, `/auth/connect/poll`) and the GitHub device flow fallback (`/auth/github/device`, `/auth/consent`, `/auth/token`), `/me` token check |
-| `src/credentials.ts` | JWT file storage (mode 0600) under the free-pi config dir |
-| `src/provider.ts` | pure builder for the `pi.registerProvider` config |
-| `src/pi-launch.ts` | the actual pi SDK integration (registers the provider, launches the TUI) |
-| `src/paths.ts` | free-pi-namespaced config dir, isolated from `~/.pi/agent` |
+- Website: https://freepi.ai
+- Docs: https://freepi.ai/docs
+- Terms: https://freepi.ai/terms
+- Privacy: https://freepi.ai/privacy
+- Changelog: [CHANGELOG.md](CHANGELOG.md)