opencharm 0.0.0 → 0.2.0
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.
- package/README.md +30 -4
- package/dist/main.mjs +4242 -0
- package/package.json +52 -4
- package/sim/THIRD_PARTY_NOTICES.md +95 -0
- package/sim/charm_sim.js +2 -0
- package/sim/charm_sim.wasm +0 -0
- package/sim/index.html +68 -0
- package/sim/mic-worklet.js +22 -0
- package/sim/sim.css +148 -0
- package/sim/sim.js +412 -0
- package/LICENSE +0 -21
package/README.md
CHANGED
|
@@ -1,9 +1,35 @@
|
|
|
1
1
|
# opencharm
|
|
2
2
|
|
|
3
|
-
The command line for [OpenCharm](https://opencharm.dev):
|
|
3
|
+
The command line for [OpenCharm](https://opencharm.dev): the open-source charm for your AI agent. A small device that becomes the face and voice of the agent you already run: Claude Code, Codex, Gemini CLI, Hermes Agent, OpenClaw, any ACP agent or anything OpenAI-compatible. A face you can type, one key, about $32 of hardware.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
```bash
|
|
6
|
+
npx opencharm
|
|
7
|
+
```
|
|
6
8
|
|
|
7
|
-
|
|
9
|
+
| Command | What it does |
|
|
10
|
+
| ----------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
11
|
+
| `opencharm` | Says hello with a blinking face |
|
|
12
|
+
| `opencharm faces` | Lists all 22 moods |
|
|
13
|
+
| `opencharm face [mood]` | Shows one mood (random if omitted), e.g. `opencharm face learned` |
|
|
14
|
+
| `opencharm states` | What your agent is doing, and the face for each state |
|
|
15
|
+
| `opencharm hardware` | What to buy and print |
|
|
16
|
+
| `opencharm init [dir]` | Clone the starter workspace ([opencharm-starter](https://github.com/opencharm-labs/opencharm-starter)) and fit it to this machine (`--agent claude` (default), `codex`, `gemini`, `goose`, `hermes`, `openclaw`; `--from <git url>` for a fork; `--name <name>` and `--colour <colour>` write the charm's identity, the `charm` block) |
|
|
17
|
+
| `opencharm serve` | Start charmd, the charm daemon, next to your agent (`--config <file>`) |
|
|
18
|
+
| `opencharm sim` | The charm on screen, in your browser, talking to charmd (`--url`, `--port`, `--no-open`) |
|
|
19
|
+
| `sudo opencharm setup --domain <d>` | Install charmd as a hardened systemd service on a Linux server (`--dry-run` prints the plan; see `docs/deploy.md`) |
|
|
20
|
+
| `opencharm pair <code>` | Pair the charm showing that code; you choose its PIN (`--name <name>`) |
|
|
21
|
+
| `opencharm status` | What's running (charmd, each connected charm's build, the starter commit of the workspace; spec 015), then the paired charms and whether they are connected, locked or blocked |
|
|
22
|
+
| `opencharm lock` / `unlock` / `revoke <charm>` | Lock it now; clear a block and unlock; forget it |
|
|
23
|
+
| `opencharm look` | Show the charm's look, or change it on every unlocked charm until charmd restarts (`--colour <colour>`, `--greeting <text>`, `--motion full\|calm`); to keep it, set `charm` in `opencharm.json` |
|
|
24
|
+
| `opencharm dev face <charm> <state> [text]` / `dev say <charm> <text>` / `dev ask <charm> <question>` | Show a face, speak, or ask a question (hold = yes, press = no) on a connected charm (testing) |
|
|
25
|
+
| `opencharm mcp` | The charm's tools for an agent (MCP over stdio): `say`, `show_face`, `ask`, `notify`, `set_look`. charmd adds it to ACP agents by itself. Other agents running as your user can add `opencharm mcp --config <file>` to their MCP settings; never an agent running as another user (it reaches charmd's admin socket) |
|
|
8
26
|
|
|
9
|
-
|
|
27
|
+
Options: `--colour white|cobalt|lime|lilac|sun|coal`, `--no-anim`, `--no-color` (also respects `NO_COLOR`).
|
|
28
|
+
|
|
29
|
+
Node 24 or newer. Runtime dependencies: `ws`, `zod`.
|
|
30
|
+
|
|
31
|
+
Source and hardware: <https://github.com/opencharm-labs/opencharm>
|
|
32
|
+
|
|
33
|
+
Development: this package lives in the OpenCharm monorepo (`packages/cli`). Run it from the repo root with `npm run cli -- <command>`; `npm run build -w packages/cli` bundles `dist/main.mjs`. `opencharm --version` prints `cli@<version> (<commit>)` (spec 015); from source it says `cli@0.0.0`: released versions come from their `cli@` tag, and each merged `fix`/`feat`/`perf` that touches the CLI publishes one (CONTRIBUTING, "Releasing").
|
|
34
|
+
|
|
35
|
+
Not affiliated with Meta, Nous Research, OpenClaw, Waveshare or Espressif.
|