@moor-sh/cli 0.2.0 → 0.2.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 (2) hide show
  1. package/README.md +75 -0
  2. package/package.json +2 -2
package/README.md ADDED
@@ -0,0 +1,75 @@
1
+ # @moor-sh/cli
2
+
3
+ Command-line interface for [moor](https://github.com/caiopizzol/moor) - manage your moor server's projects, logs, env vars, and container lifecycle from a terminal. Ships a `moor` binary.
4
+
5
+ Requires [Bun](https://bun.sh) on the machine running the CLI.
6
+
7
+ ## Install
8
+
9
+ **One-shot** (no install):
10
+
11
+ ```bash
12
+ bunx @moor-sh/cli status
13
+ ```
14
+
15
+ **Global install** (puts `moor` on PATH):
16
+
17
+ ```bash
18
+ bun add -g @moor-sh/cli
19
+ moor status
20
+ ```
21
+
22
+ Don't use `bunx moor` (without the scope) - `moor` on npm is an unrelated package.
23
+
24
+ ## Configure
25
+
26
+ ```bash
27
+ export MOOR_URL=https://moor.example.com # or http://127.0.0.1:8080 via SSH tunnel
28
+ export MOOR_API_KEY=your-api-key
29
+ ```
30
+
31
+ `MOOR_API_KEY` grants admin-equivalent control of the moor host. See the [self-hosting guide](https://github.com/caiopizzol/moor/blob/main/docs/self-hosting.md#api-keys) for how to generate and rotate it.
32
+
33
+ For a remote moor with private admin (the default), open an SSH tunnel from your laptop before running CLI commands:
34
+
35
+ ```bash
36
+ ssh -L 8080:127.0.0.1:3000 your-server
37
+ export MOOR_URL=http://127.0.0.1:8080
38
+ ```
39
+
40
+ ## Commands
41
+
42
+ ```
43
+ moor status # list all projects
44
+ moor logs <project> [-f] [-n 100] # view container logs
45
+ moor rebuild <project> # rebuild from source
46
+ moor restart <project> # stop + start
47
+ moor exec <project> <command> # run a command in the container
48
+ moor env list <project> # list environment variables
49
+ moor env set <project> KEY=VALUE # set environment variables and restart
50
+ moor stats # server resource usage
51
+ moor mcp config --client <name> # generate MCP client config snippet
52
+ ```
53
+
54
+ ## `moor mcp config`
55
+
56
+ Generates a ready-to-paste config snippet for an MCP-compatible AI client. Removes the "open a doc, copy a JSON block, fill in the blanks" step from MCP setup.
57
+
58
+ ```bash
59
+ moor mcp config --client claude # or --client claude-code (alias)
60
+ moor mcp config --client codex
61
+ ```
62
+
63
+ Output is JSON for `claude` / `claude-code` and TOML for `codex`. Prints to stdout - redirect or paste into `~/.claude.json` or `~/.codex/config.toml`. Optional flags: `--url <url>` (default `http://127.0.0.1:8080`), `--api-key <key>` (else read from `MOOR_API_KEY` env, then cwd `.env`, then a placeholder).
64
+
65
+ See [`@moor-sh/mcp`](https://www.npmjs.com/package/@moor-sh/mcp) for the MCP server itself.
66
+
67
+ ## Links
68
+
69
+ - [moor repo](https://github.com/caiopizzol/moor) - main project, install instructions
70
+ - [Self-hosting guide](https://github.com/caiopizzol/moor/blob/main/docs/self-hosting.md) - first boot, API keys, admin domain, port model
71
+ - [`@moor-sh/mcp`](https://www.npmjs.com/package/@moor-sh/mcp) - MCP server for AI agent integration
72
+
73
+ ## License
74
+
75
+ MIT.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@moor-sh/cli",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "description": "Command-line interface for moor - manage your moor server's projects, logs, env vars, and container lifecycle.",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -8,7 +8,7 @@
8
8
  "url": "https://github.com/caiopizzol/moor.git",
9
9
  "directory": "packages/cli"
10
10
  },
11
- "homepage": "https://github.com/caiopizzol/moor#cli",
11
+ "homepage": "https://github.com/caiopizzol/moor/tree/main/packages/cli",
12
12
  "bugs": "https://github.com/caiopizzol/moor/issues",
13
13
  "keywords": [
14
14
  "moor",