copillm 0.1.0 → 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jason C
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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 NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS 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 THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,52 +1,73 @@
 # copillm
 
-> **Unofficial proxy to make your Copilot CLI seat power everything.**
-
 [![PR gate](https://github.com/jcjc-dev/copillm/actions/workflows/pr-gate.yml/badge.svg?branch=main)](https://github.com/jcjc-dev/copillm/actions/workflows/pr-gate.yml)
-[![Release gate (nightly + on release)](https://github.com/jcjc-dev/copillm/actions/workflows/release-gate.yml/badge.svg?branch=main&event=schedule)](https://github.com/jcjc-dev/copillm/actions/workflows/release-gate.yml)
+[![Release gate](https://github.com/jcjc-dev/copillm/actions/workflows/release-gate.yml/badge.svg?branch=main&event=schedule)](https://github.com/jcjc-dev/copillm/actions/workflows/release-gate.yml)
+[![npm version](https://img.shields.io/npm/v/copillm.svg)](https://www.npmjs.com/package/copillm)
+[![Node.js version](https://img.shields.io/node/v/copillm.svg)](https://www.npmjs.com/package/copillm)
 
-A local proxy that exposes OpenAI- and Anthropic-compatible HTTP endpoints backed by your GitHub Copilot subscription. One login — point Codex CLI, Claude Code, or any compatible tool at it and go.
+A local proxy that exposes OpenAI- and Anthropic-compatible HTTP endpoints backed by a GitHub Copilot CLI subscription. A single login provides a unified gateway that Codex CLI, Claude Code, and other compatible tools can target directly.
 
-> ⚠️ **Experimental / research tool.** Independent, unofficial client of GitHub Copilot's private API. Not affiliated with GitHub, Microsoft, OpenAI, or Anthropic. The upstream API can change without notice. Use at your own risk.
+## Requirements
 
----
+- Node.js 20 or later
+- An active GitHub Copilot subscription
 
-## Quick start
+## Installation
+
+`copillm` is distributed on [npm](https://www.npmjs.com/package/copillm). Install it globally for the most convenient usage:
 
 ```bash
-# 1. one-time login (GitHub device flow)
-npx copillm login
+npm install -g copillm
 
-# 2. launch your agent — copillm auto-starts the daemon, installs the agent if needed,
-#    and wires up all env vars for you
-npx copillm claude    # Claude Code, preconfigured
-npx copillm codex     # Codex CLI, preconfigured
+copillm --help
 ```
 
-Requires Node.js ≥ 20. That's it — no global install, no config files, no API keys to juggle.
+Alternatively, you can invoke it directly with `npx` without a global install:
+
+```bash
+npx copillm --help
+```
 
-Pass extra args through with `--`:
+## Quick start
 
 ```bash
-copillm claude -- --model opus
-copillm codex  -- --help
+# Authenticate once via the GitHub device flow.
+copillm login
+
+# Launch an agent. copillm starts the local daemon, installs the agent if
+# necessary, and configures the required environment variables.
+copillm claude
+copillm codex
 ```
 
----
+Arguments after the agent name are forwarded to the underlying CLI:
 
-## Documentation
+```bash
+copillm claude --model opus
+copillm codex --help
+```
 
-Full docs live at **[jcjc-dev.github.io/copillm](https://jcjc-dev.github.io/copillm/)**:
+## Documentation
 
-- **[Getting started](https://jcjc-dev.github.io/copillm/getting-started/)** — install, login, first run
-- **[CLI reference](https://jcjc-dev.github.io/copillm/cli-reference/)** — every command and flag
-- **[Using with Claude Code](https://jcjc-dev.github.io/copillm/claude-code/)** — env wiring, gateway discovery, the `[1m]` 1M-context alias
-- **[Using with Codex CLI](https://jcjc-dev.github.io/copillm/codex/)** — env wiring, `config.toml` generation
-- **[HTTP API reference](https://jcjc-dev.github.io/copillm/http-api/)** — endpoints, translation caveats
-- **[Building from source & CI](https://jcjc-dev.github.io/copillm/development/)** — for contributors
+Full documentation is published at **[jcjc-dev.github.io/copillm](https://jcjc-dev.github.io/copillm/)**.
 
----
+| Topic | Description |
+| --- | --- |
+| [Getting started](https://jcjc-dev.github.io/copillm/getting-started/) | Installation, authentication, and first run |
+| [CLI reference](https://jcjc-dev.github.io/copillm/cli-reference/) | Commands and flags |
+| [Using with Claude Code](https://jcjc-dev.github.io/copillm/claude-code/) | Environment wiring, gateway discovery, the `[1m]` 1M-context alias |
+| [Using with Codex CLI](https://jcjc-dev.github.io/copillm/codex/) | Environment wiring and `config.toml` generation |
+| [HTTP API reference](https://jcjc-dev.github.io/copillm/http-api/) | Endpoints and translation behaviour |
+| [Building from source](https://jcjc-dev.github.io/copillm/development/) | Contributor and CI guide |
 
 ## Contributing
 
-Issues and PRs welcome — see the [development guide](https://jcjc-dev.github.io/copillm/development/).
+Bug reports and pull requests are welcome. Please read the [development guide](https://jcjc-dev.github.io/copillm/development/) before opening a pull request.
+
+## Disclaimer
+
+`copillm` is an independent, unofficial client of GitHub Copilot's private API. It is not affiliated with, endorsed by, or supported by GitHub, Microsoft, OpenAI, or Anthropic. The upstream API may change at any time without notice. Use this project at your own risk.
+
+## License
+
+Released under the [MIT License](LICENSE).

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "copillm",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Local Copilot proxy CLI (OpenAI/Anthropic-compatible)",
+  "license": "MIT",
   "type": "module",
   "bin": {
     "copillm": "./dist/cli.js"