@ccode-si/cli 0.0.0-stage → 1.0.3

package/LICENSE

@@ -0,0 +1,54 @@
+CCode — Proprietary License
+
+Copyright (c) 2026 CCode (ccode.si). All rights reserved.
+
+This license covers CCode: the `ccode` program, the @ccode-si/cli npm
+package and its platform packages, and their documentation (the
+"Software"). Components made by others are covered by their own licenses
+instead; see THIRD_PARTY_NOTICES.txt.
+
+1. Use. You may install the Software and run it on devices you own or
+   control, for personal or commercial work, free of charge.
+
+2. Restrictions. Except as allowed in section 3 or by applicable law, you
+   may not:
+   (a) copy, redistribute, sell, rent, lease, sublicense or otherwise make
+       the Software available to others (pointing them to the official npm
+       package is fine);
+   (b) modify, translate or create derivative works of the Software;
+   (c) reverse engineer, decompile, disassemble or deobfuscate the
+       Software, or try to derive its source code;
+   (d) remove or change this license, copyright notices or the third-party
+       notices.
+
+3. Third-party components. The Software includes components licensed by
+   others, listed in THIRD_PARTY_NOTICES.txt, among them the Bun runtime
+   with JavaScriptCore/WebKit (GNU LGPL version 2) and TinyCC (GNU LGPL
+   version 2.1). Nothing in this license limits the rights those licenses
+   give you. In particular, for the LGPL-licensed libraries you may modify
+   them and relink them with the Software for your own use, and reverse
+   engineer the Software to the extent needed to debug such modifications.
+   Where to get their source code is set out in THIRD_PARTY_NOTICES.txt.
+
+4. Your data. The Software runs on your device. It sends your prompts and
+   the content you work on to the AI model providers you configure, under
+   their terms, and keeps your settings, API keys and sessions on your
+   device.
+
+5. No warranty. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+   KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
+   You are responsible for reviewing the changes the Software makes and
+   the commands it runs on your behalf.
+
+6. Limitation of liability. TO THE MAXIMUM EXTENT PERMITTED BY LAW, IN NO
+   EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR
+   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR ITS USE,
+   INCLUDING LOSS OF DATA, CODE OR PROFITS.
+
+7. Termination. This license ends automatically if you break its terms.
+   You must then stop using the Software and delete your copies.
+
+8. New versions. A new version of the Software may come with a different
+   license; the license included with a version applies to that version.

package/README.md

@@ -1,3 +1,102 @@
-# Temporary Holding Version
+# CCode
 
-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.
+A coding agent for your terminal. Describe what you want in plain language; CCode reads your project, edits files, runs commands and checks its work, with any model you choose.
+
+```bash
+npm install -g @ccode-si/cli
+ccode
+```
+
+Runs on macOS (Apple silicon and Intel), Linux (x64 and arm64) and Windows (x64 and arm64). Needs Node 18 or newer to install.
+
+## Getting started
+
+1. Open a terminal in your project and run `ccode`.
+2. Press `ctrl+p`, choose **Connect provider**, paste an API key and pick a model.
+3. Type what you want done and press enter.
+
+```bash
+ccode                    # start in the current folder
+ccode -c                 # continue the latest session here
+ccode -r <id>            # resume a session by id
+ccode -p "<prompt>"      # one answer on stdout, for scripts
+ccode update             # install the newest version
+```
+
+## Features
+
+**Any model**
+- Anthropic, OpenAI, Google Gemini, DeepSeek, OpenRouter, CoreWeave and the Z.ai coding plan, connected from inside the app.
+- Local models through Ollama, LM Studio, llama.cpp, vLLM or any OpenAI-compatible server.
+- Switch model mid-session with `/model`; set the thinking effort per model with `/effort`.
+
+**Works in your project**
+- Reads, searches, writes and edits files, and runs shell commands, including long ones in the background.
+- Reads images and PDFs, searches the web and fetches pages.
+- Plans multi-step work as a task list you can follow as it goes.
+- `@` attaches files to a message, `ctrl+v` pastes an image from the clipboard; messages typed while it works are queued.
+
+**You stay in control**
+- Four permission modes, cycled with `shift+tab`: **Auto**, **Accept edits**, **Manual** and **Plan** (read-only: it explores and proposes a plan for you to approve).
+- Allow or deny rules for commands, paths, tools and websites, kept in your own settings.
+- A repository you open can't grant itself permissions, change your model or start servers without your approval.
+
+**Nothing is lost**
+- Every session is saved. `/session` browses, searches and resumes them; `/fork` copies one to try something else.
+- `/undo` and `/redo` step through the conversation; `/rewind` puts files and conversation back to before any turn.
+- Long conversations are summarized automatically, so a task can keep going.
+- Memory: CCode remembers your corrections and standing preferences across sessions (`/memory`).
+
+**Extend it**
+- **Subagents** take on searches and side tasks in their own context, also in the background. Add your own.
+- **Skills**: packaged instructions the agent loads when they fit, or that you run as `/<name>`.
+- **MCP servers**: `ccode mcp add …`, with the same syntax as other agents' install lines.
+- **Hooks**: your own commands before and after tool calls, on each message, and when a task ends.
+- **Instruction files**: `CCODE.md`, `AGENTS.md` and `CLAUDE.md` in a project are followed.
+
+**A terminal UI that stays out of the way**
+- Streaming answers, coloured diffs for edits, and quiet steps folded into one line.
+- A sidebar with context used, cost, tasks and modified files.
+- Tabs for several sessions at once (turn on "Tabs" in settings), reopened next time.
+- Syntax highlighting with a choice of themes; a transparent or black background.
+- Desktop notifications when a task finishes or needs you.
+- `/usage` shows your tokens, active days and streaks.
+
+## Keys
+
+| Key | Action |
+|---|---|
+| `ctrl+p` | every setting and command, searchable |
+| `shift+tab` | cycle the permission mode |
+| `shift+enter` | new line |
+| `ctrl+v` | paste an image from the clipboard (`alt+v` also works) |
+| `esc esc` | stop the response |
+| `ctrl+b` | move the running command to the background |
+| `ctrl+t` / `ctrl+n` | with tabs on: new tab / next tab |
+| `ctrl+c` twice | quit |
+
+## Commands
+
+`/help` lists every command. The ones you'll use most:
+
+| Command | What it does |
+|---|---|
+| `/model` | change the model |
+| `/session` | browse and resume sessions |
+| `/new` | start a fresh session |
+| `/cd <path>` | move to another folder |
+| `/compact` | summarize the conversation to free up context |
+| `/btw <question>` | ask a side question without adding it to the conversation |
+| `/undo` `/redo` `/rewind` | step back and forward |
+| `/mcp` `/skills` `/hooks` `/memory` | what's installed and remembered |
+| `/settings` | preferences |
+
+## Settings
+
+Preferences live in `~/.ccode/settings.json`; `ccode config` shows what is in effect and where it came from. API keys are kept apart from settings, in a file only you can read, or taken from environment variables such as `ANTHROPIC_API_KEY` and `OPENAI_API_KEY`.
+
+CCode checks for a newer version once a day and tells you when there is one. Turn that off with `"updateCheck": false`.
+
+## License
+
+CCode is proprietary software: free to install and use, all other rights reserved. See `LICENSE`. Third-party notices ship in `THIRD_PARTY_NOTICES.txt`.