@lumoai/cli 1.0.0 → 1.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 CHANGED
@@ -14,6 +14,41 @@ Verify:
14
14
  lumo --version
15
15
  ```
16
16
 
17
+ ## One-Shot Setup for Claude Code
18
+
19
+ If you use [Claude Code](https://claude.com/claude-code), wire up the Lumo skill + hooks in one command — no install required upfront:
20
+
21
+ ```bash
22
+ npx @lumoai/cli setup
23
+ ```
24
+
25
+ The command interactively asks whether to install for the current user (`~/.claude/`) or just the current project (`./.claude/`), then:
26
+
27
+ 1. Drops the `SKILL.md` into `.claude/skills/lumo/`
28
+ 2. Idempotently merges 25 Lumo hook handlers into `.claude/settings.json` (existing hooks and permissions are preserved)
29
+ 3. Prints any remaining steps (global install, `lumo auth login`)
30
+
31
+ Non-interactive flags for CI / scripts:
32
+
33
+ ```bash
34
+ npx @lumoai/cli setup --project
35
+ npx @lumoai/cli setup --user --force
36
+ ```
37
+
38
+ After `setup`, install the CLI globally so Claude Code's hooks can resolve the `lumo` binary at startup:
39
+
40
+ ```bash
41
+ npm install -g @lumoai/cli
42
+ ```
43
+
44
+ ## Update
45
+
46
+ ```bash
47
+ lumo update
48
+ ```
49
+
50
+ Checks npm for a newer release and runs `npm install -g @lumoai/cli@latest` if one is available. The CLI also performs a background check once every 24 hours and prints a one-line notice on subsequent invocations when an upgrade is available.
51
+
17
52
  ## Authentication
18
53
 
19
54
  ```bash
@@ -58,8 +93,10 @@ lumo task update LUM-42 --status done
58
93
 
59
94
  | Group | Highlights |
60
95
  | --------------- | ------------------------------------------------------------- |
96
+ | `setup` | Install SKILL.md + hooks into `~/.claude/` or `./.claude/` |
61
97
  | `auth` | `login`, `logout` |
62
98
  | `whoami` | Show current identity + workspace |
99
+ | `update` | Self-update to the latest npm release |
63
100
  | `task` | `create`, `update`, `list`, `show`, `comment`, `context` |
64
101
  | `session` | `attach`, `status`, `detach` (binds Claude Code sessions) |
65
102
  | `project` | `list` |
@@ -74,13 +111,6 @@ lumo task create --help
74
111
  lumo sprint close --help
75
112
  ```
76
113
 
77
- ## Environment Variables
78
-
79
- | Variable | Default | Purpose |
80
- | ------------------------- | ------------------------ | ------------------------------------------------------------- |
81
- | `LUMO_API_URL` | `https://www.uselumo.ai` | Override the API endpoint (e.g. self-hosted Lumo instance). |
82
- | `CLAUDE_CODE_SESSION_ID` | _(set by Claude Code)_ | Required for `session attach` / `status` / `detach`. |
83
-
84
114
  ## Claude Code Integration
85
115
 
86
116
  Inside a Claude Code session, the agent skill auto-discovers the CLI and uses it to load task context, bind sessions, and update task state. See the [Lumo Claude Code skill](https://github.com/Lumo-Workspace/lumo/tree/main/.claude/skills/lumo) for the full agent contract.