copillm 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +41 -28
  3. package/dist/cli.js +0 -0
  4. package/package.json +2 -1
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Jason C
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,52 +1,65 @@
1
1
  # copillm
2
2
 
3
- > **Unofficial proxy to make your Copilot CLI seat power everything.**
4
-
5
3
  [![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)
6
- [![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)
4
+ [![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)
5
+ [![npm version](https://img.shields.io/npm/v/copillm.svg)](https://www.npmjs.com/package/copillm)
6
+ [![Node.js version](https://img.shields.io/node/v/copillm.svg)](https://www.npmjs.com/package/copillm)
7
+
8
+ 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.
7
9
 
8
- 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.
10
+ ## Requirements
9
11
 
10
- > ⚠️ **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.
12
+ - Node.js 20 or later
13
+ - An active GitHub Copilot subscription
11
14
 
12
- ---
15
+ ## Installation
16
+
17
+ `copillm` is distributed on npm and can be invoked directly with `npx`. A global install is not required.
18
+
19
+ ```bash
20
+ npx copillm --help
21
+ ```
13
22
 
14
23
  ## Quick start
15
24
 
16
25
  ```bash
17
- # 1. one-time login (GitHub device flow)
26
+ # Authenticate once via the GitHub device flow.
18
27
  npx copillm login
19
28
 
20
- # 2. launch your agent — copillm auto-starts the daemon, installs the agent if needed,
21
- # and wires up all env vars for you
22
- npx copillm claude # Claude Code, preconfigured
23
- npx copillm codex # Codex CLI, preconfigured
29
+ # Launch an agent. copillm starts the local daemon, installs the agent if
30
+ # necessary, and configures the required environment variables.
31
+ npx copillm claude
32
+ npx copillm codex
24
33
  ```
25
34
 
26
- Requires Node.js ≥ 20. That's it — no global install, no config files, no API keys to juggle.
27
-
28
- Pass extra args through with `--`:
35
+ Arguments after the agent name are forwarded to the underlying CLI:
29
36
 
30
37
  ```bash
31
- copillm claude -- --model opus
32
- copillm codex -- --help
38
+ copillm claude --model opus
39
+ copillm codex --help
33
40
  ```
34
41
 
35
- ---
36
-
37
42
  ## Documentation
38
43
 
39
- Full docs live at **[jcjc-dev.github.io/copillm](https://jcjc-dev.github.io/copillm/)**:
40
-
41
- - **[Getting started](https://jcjc-dev.github.io/copillm/getting-started/)** — install, login, first run
42
- - **[CLI reference](https://jcjc-dev.github.io/copillm/cli-reference/)** — every command and flag
43
- - **[Using with Claude Code](https://jcjc-dev.github.io/copillm/claude-code/)** — env wiring, gateway discovery, the `[1m]` 1M-context alias
44
- - **[Using with Codex CLI](https://jcjc-dev.github.io/copillm/codex/)** — env wiring, `config.toml` generation
45
- - **[HTTP API reference](https://jcjc-dev.github.io/copillm/http-api/)** — endpoints, translation caveats
46
- - **[Building from source & CI](https://jcjc-dev.github.io/copillm/development/)** — for contributors
44
+ Full documentation is published at **[jcjc-dev.github.io/copillm](https://jcjc-dev.github.io/copillm/)**.
47
45
 
48
- ---
46
+ | Topic | Description |
47
+ | --- | --- |
48
+ | [Getting started](https://jcjc-dev.github.io/copillm/getting-started/) | Installation, authentication, and first run |
49
+ | [CLI reference](https://jcjc-dev.github.io/copillm/cli-reference/) | Commands and flags |
50
+ | [Using with Claude Code](https://jcjc-dev.github.io/copillm/claude-code/) | Environment wiring, gateway discovery, the `[1m]` 1M-context alias |
51
+ | [Using with Codex CLI](https://jcjc-dev.github.io/copillm/codex/) | Environment wiring and `config.toml` generation |
52
+ | [HTTP API reference](https://jcjc-dev.github.io/copillm/http-api/) | Endpoints and translation behaviour |
53
+ | [Building from source](https://jcjc-dev.github.io/copillm/development/) | Contributor and CI guide |
49
54
 
50
55
  ## Contributing
51
56
 
52
- Issues and PRs welcome — see the [development guide](https://jcjc-dev.github.io/copillm/development/).
57
+ Bug reports and pull requests are welcome. Please read the [development guide](https://jcjc-dev.github.io/copillm/development/) before opening a pull request.
58
+
59
+ ## Disclaimer
60
+
61
+ `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.
62
+
63
+ ## License
64
+
65
+ Released under the [MIT License](LICENSE).
package/dist/cli.js CHANGED
File without changes
package/package.json CHANGED
@@ -1,7 +1,8 @@
1
1
  {
2
2
  "name": "copillm",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Local Copilot proxy CLI (OpenAI/Anthropic-compatible)",
5
+ "license": "MIT",
5
6
  "type": "module",
6
7
  "bin": {
7
8
  "copillm": "./dist/cli.js"