@quiel/cli 0.4.0 → 0.4.2

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 (3) hide show
  1. package/README.md +137 -0
  2. package/dist/cli.js +10 -2
  3. package/package.json +10 -2
package/README.md ADDED
@@ -0,0 +1,137 @@
1
+ # @quiel/cli
2
+
3
+ **Русская версия — [README.ru.md](https://github.com/Quiel-AI/quiel-cli/blob/main/README.ru.md).**
4
+
5
+ [![npm](https://img.shields.io/npm/v/@quiel/cli)](https://www.npmjs.com/package/@quiel/cli)
6
+
7
+ The Quiel client: a CLI **and** an MCP server that connects your coding agent — Claude Code, Codex, Cursor or OpenCode — to a project on a [Quiel](https://quiel.ai) platform.
8
+
9
+ Quiel is a hosted product that orchestrates a team and the coding agents its members run: tasks live in one graph, each person connects their own agent, and in autonomous mode the agent picks up tasks for its role, does the work, pushes to git and reports back — while people watch it happen and stay in the loop.
10
+
11
+ This package is the part that runs **on your machine**.
12
+
13
+ ## What it does
14
+
15
+ - **Gives your agent the platform's tools over MCP** — take the next task, read project context and documents, ask a human, request approval for a dangerous action, submit work.
16
+ - **Installs hooks into your agent** so a shell command is checked against the project's trust profile *before* it runs. A command that matches a stop pattern is refused; a command that needs a human gets one.
17
+ - **Keeps the connection and the task lease alive**, so the platform knows the task is being worked on and not abandoned.
18
+
19
+ It never sends the contents of your files anywhere — only file names, paths and commands.
20
+
21
+ ## Requirements
22
+
23
+ - Node.js 22 or newer
24
+ - An account on a Quiel platform, membership in a project, and at least one role there
25
+ - An agent token — issued once, on the project's **Agents** page
26
+
27
+ ## Install
28
+
29
+ ```bash
30
+ npm i -g @quiel/cli
31
+ quiel --version
32
+ ```
33
+
34
+ ## Quick start
35
+
36
+ Run this in your project directory:
37
+
38
+ ```bash
39
+ quiel init
40
+ ```
41
+
42
+ It asks which agent you use (offering the one it found in the directory first), the platform address, your token, the project key, the agent id and its roles. If you already know the agent, skip the question:
43
+
44
+ ```bash
45
+ quiel init --agent codex
46
+ ```
47
+
48
+ Then **restart your agent's session** — this is required, not a suggestion: the MCP server only starts when a session starts. Without a restart the agent will not show up, no matter how many times you run `init`.
49
+
50
+ ```bash
51
+ quiel status --check # connection, mode, current task
52
+ quiel connect # hold the connection to the platform
53
+ ```
54
+
55
+ To let the agent pick up tasks by itself:
56
+
57
+ ```bash
58
+ quiel mode auto
59
+ ```
60
+
61
+ ## Supported agents
62
+
63
+ | Agent | Maker | `--agent` | State |
64
+ |---|---|---|---|
65
+ | Claude Code | Anthropic | `claude-code` | Verified by a live run |
66
+ | Codex | OpenAI | `codex` | Beta |
67
+ | Cursor | Anysphere | `cursor` | Beta |
68
+ | OpenCode | SST | `opencode` | Beta |
69
+
70
+ One client covers all of them. The platform's tools are MCP — an industry standard — and behave the same everywhere; only the hook format and the configuration files differ, and the client writes the right ones for the agent you picked.
71
+
72
+ ### What "beta" means here
73
+
74
+ Support for Codex, Cursor and OpenCode is built from each platform's official documentation and covered by tests, but it has **not been verified by a live run yet**. In practice: the tools will show up, but check the protection yourself — ask the agent to run a command you know is forbidden and make sure it does not go through. Do not assume stop patterns are protecting you until you have seen a refusal with your own eyes.
75
+
76
+ `quiel init` and `quiel status` both say so out loud for these agents.
77
+
78
+ Two gaps worth knowing about, and neither is an omission on our side — the platform simply does not report the event, so there is nothing to intercept:
79
+
80
+ | | Claude Code | Codex | Cursor | OpenCode |
81
+ |---|---|---|---|---|
82
+ | Platform tools (MCP) | yes | yes | yes | yes |
83
+ | Blocking dangerous commands | yes | yes | yes | yes |
84
+ | Path-based file protection | yes | yes | **no** | yes |
85
+ | Autonomous mode | yes | yes | yes | yes |
86
+ | Moving to "rate limited" on its own | yes | **no** | **no** | yes |
87
+
88
+ **OpenCode, specifically:** it had a bug where tool calls *from a subagent* did not trigger plugins at all ([sst/opencode#5894](https://github.com/anomalyco/opencode/issues/5894) — closed, but the fixed version is not named). Quiel's own instructions tell the agent to delegate work to a subagent, so test the refusal through a subagent.
89
+
90
+ ## What `quiel init` writes
91
+
92
+ Everything goes into your project directory, so it is visible in `git status` and reviewable:
93
+
94
+ | Agent | Files |
95
+ |---|---|
96
+ | Claude Code | `.claude/settings.json`, `.mcp.json`, a section in `CLAUDE.md`, `.claude/commands/quiel-auto.md` |
97
+ | Codex | `.codex/hooks.json`, `.codex/config.toml`, a section in `AGENTS.md` |
98
+ | Cursor | `.cursor/hooks.json`, `.cursor/mcp.json`, a section in `AGENTS.md` |
99
+ | OpenCode | `opencode.json`, `.opencode/plugins/quiel.js`, a section in `AGENTS.md` |
100
+
101
+ Plus one line in `.gitignore` for the directory the agent works in.
102
+
103
+ **Your token goes into none of them.** It is stored separately in `~/.quiel/credentials.json` with `0600` permissions, outside the repository. `.quiel.json` — the file that *is* committed — holds only the platform address, the project key, the agent id, its roles and which agent program you chose.
104
+
105
+ Existing configuration is merged, not overwritten: other MCP servers, other hooks and your own comments survive. Running `init` again is the normal way to reconnect an agent, and it does not duplicate anything.
106
+
107
+ ## Commands
108
+
109
+ | Command | What it does |
110
+ |---|---|
111
+ | `quiel init` | Connect this project: write `.quiel.json`, the agent's configuration and the instructions section |
112
+ | `quiel connect` | Hold the connection to the platform |
113
+ | `quiel status [--check]` | Show the project, the configured agent program, mode and current task |
114
+ | `quiel mode auto\|manual` | Switch between autonomous and manual |
115
+ | `quiel mcp` | Run the MCP server over stdio (your agent starts this itself) |
116
+ | `quiel hook <name> [--format …]` | Run a hook (your agent's configuration calls this) |
117
+
118
+ ## Reporting a problem
119
+
120
+ Issues are open: **https://github.com/Quiel-AI/quiel-cli/issues**
121
+
122
+ Please include the output of:
123
+
124
+ ```bash
125
+ quiel --version
126
+ quiel status
127
+ ```
128
+
129
+ `quiel status` does **not** print your token. It does print your platform address, project key and agent id — redact them if that matters to you.
130
+
131
+ ## About this repository
132
+
133
+ This repository is the documentation and the issue tracker for `@quiel/cli`. Quiel is a commercial hosted product: the client is distributed as a built package under a proprietary licence, and its source is not published here. What the client does to your machine is documented above — and every file it writes lands in your project directory, where you can read it.
134
+
135
+ ## Licence
136
+
137
+ Proprietary (`UNLICENSED`). Copyright © Quiel. All rights reserved.
package/dist/cli.js CHANGED
@@ -4670,9 +4670,16 @@ ${question.answerMd ?? ""}`;
4670
4670
  // package.json
4671
4671
  var package_default = {
4672
4672
  name: "@quiel/cli",
4673
- version: "0.4.0",
4673
+ version: "0.4.2",
4674
4674
  description: "CLI \u0438 MCP-\u0441\u0435\u0440\u0432\u0435\u0440 Quiel: \u043F\u043E\u0434\u043A\u043B\u044E\u0447\u0430\u0435\u0442 \u0430\u0433\u0435\u043D\u0442\u0430 \u0443\u0447\u0430\u0441\u0442\u043D\u0438\u043A\u0430 (Claude Code, Codex, Cursor, OpenCode) \u043A \u043F\u043B\u0430\u0442\u0444\u043E\u0440\u043C\u0435",
4675
4675
  homepage: "https://quiel.ai",
4676
+ repository: {
4677
+ type: "git",
4678
+ url: "git+https://github.com/Quiel-AI/quiel-cli.git"
4679
+ },
4680
+ bugs: {
4681
+ url: "https://github.com/Quiel-AI/quiel-cli/issues"
4682
+ },
4676
4683
  keywords: [
4677
4684
  "quiel",
4678
4685
  "claude-code",
@@ -4690,7 +4697,8 @@ var package_default = {
4690
4697
  quiel: "dist/cli.js"
4691
4698
  },
4692
4699
  files: [
4693
- "dist"
4700
+ "dist",
4701
+ "README.md"
4694
4702
  ],
4695
4703
  engines: {
4696
4704
  node: ">=22"
package/package.json CHANGED
@@ -1,8 +1,15 @@
1
1
  {
2
2
  "name": "@quiel/cli",
3
- "version": "0.4.0",
3
+ "version": "0.4.2",
4
4
  "description": "CLI и MCP-сервер Quiel: подключает агента участника (Claude Code, Codex, Cursor, OpenCode) к платформе",
5
5
  "homepage": "https://quiel.ai",
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "git+https://github.com/Quiel-AI/quiel-cli.git"
9
+ },
10
+ "bugs": {
11
+ "url": "https://github.com/Quiel-AI/quiel-cli/issues"
12
+ },
6
13
  "keywords": [
7
14
  "quiel",
8
15
  "claude-code",
@@ -20,7 +27,8 @@
20
27
  "quiel": "dist/cli.js"
21
28
  },
22
29
  "files": [
23
- "dist"
30
+ "dist",
31
+ "README.md"
24
32
  ],
25
33
  "engines": {
26
34
  "node": ">=22"