clixad 0.0.1-beta.3 → 0.0.1-beta.30

package/README.md

@@ -1,8 +1,25 @@
 # clixad
 
 A terminal coding agent that routes model calls through the Clixad metering gateway. No
-subscription: you earn credits by completing rewarded offers in your browser and spend them on real
-model API calls.
+subscription: the cheapest models are free to use up to a daily allowance, and past that you earn
+credits by completing rewarded offers in your browser and spend them on real model API calls.
+
+`/model` marks which models are free and shows roughly how many free turns the allowance still buys
+on each — the same allowance goes a lot further on the cheapest one. The status line counts it down,
+and once it is gone the model carries on against credits. The REPL names the free models when it
+opens and again if your balance runs out. `/help` leads with them too, and a new account starts on
+one.
+
+While you type a task, the status line shows roughly what it will cost and whether your credits
+cover it, for example `task ≈ 560–3.1k · free` or `task ≈ 7.5k–47k · not enough, /model`. It is an
+estimate from the size of the conversation and how tasks usually run; what is charged is what the
+model actually used.
+
+`/effort` sets how long the model thinks before it answers, saved separately for each model.
+Thinking is billed as output tokens like the answer, so a higher setting costs more credits per turn
+and a lower one costs less. `auto` leaves the model at its own default, and a model with nothing to
+adjust says so. The cost preview is not shown while a setting above the model's default is active,
+because it is measured at the defaults.
 
 **Early beta.** Commands, interfaces and credit mechanics may change between beta versions. Run the
 most recent published build with:
@@ -19,6 +36,31 @@ npm install -g clixad
 
 Requires Node.js >= 20.
 
+## Community
+
+Discord: <https://discord.gg/pwxPM3QyF> — bug reports and feature requests are read there.
+
+## What it does
+
+It reads, searches and edits files and runs shell commands in the directory you start it in, asking
+before it changes anything (`shift+tab` cycles between asking, auto-accepting edits, and a read-only
+plan mode). Beyond that:
+
+- **Reads the web** — searches for current documentation and error messages, and fetches a page,
+  JSON endpoint or PDF to read it.
+- **Runs things in the background** — dev servers, watchers, tailed logs. They keep running across
+  turns; `/bg` lists them and stops them, and nothing survives the session.
+- **Looks at images** — point it at a screenshot with `@shot.png` and it sees the picture, not the
+  filename.
+- **Delegates wide searches** to a sub-agent, so the forty files it opened to find the three that
+  mattered stay out of the conversation you are paying for.
+- **Keeps a task list** on multi-step work, and **asks you** when guessing wrong would waste real
+  work.
+- **Uses MCP servers** you configure in `.mcp.json` or `~/.clixad/mcp.json`; `/mcp` shows their
+  status. Every tool a server offers is put to you before it runs.
+
+Type `/help` for the commands, `@` to attach a file, and `!` to run a shell command yourself.
+
 ## Status
 
 Pre-release, published under the `beta` dist-tag. `npx clixad` resolves to the latest published