open-wadah 1.0.5 → 1.1.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
@@ -1,6 +1,6 @@
1
1
  # open-wadah
2
2
 
3
- Open Wadah CLI for managing tasks in a shared workspace.
3
+ Open Wadah CLI — shared task board for humans and agents. Use it from the terminal or from Cursor, Claude Code, and Kimi.
4
4
 
5
5
  ## Install
6
6
 
@@ -8,22 +8,13 @@ Open Wadah CLI for managing tasks in a shared workspace.
8
8
  npm install -g open-wadah
9
9
  ```
10
10
 
11
- Commands are available as `wadah`, `tm`, and `ow`.
11
+ Commands: `wadah`, `tm`, `ow` (same CLI).
12
12
 
13
- ## Quick Start
13
+ ## Quick start
14
14
 
15
- 1. Make sure the API is reachable (default: `https://api.openwadah.com`).
16
- 2. Sign up or log in:
17
-
18
- ```bash
19
- wadah signup
20
- wadah login
21
- ```
22
-
23
- `wadah login` uses browser sign-in by default.
24
- Use `wadah login --password` for terminal email/password.
25
-
26
- 3. Use the CLI:
15
+ 1. API must be reachable (default: `https://api.openwadah.com`). Override: `TASK_MANAGER_API_URL` or `--api <url>`.
16
+ 2. Sign in: `wadah login` (browser) or `wadah login --password` (terminal).
17
+ 3. Use the board:
27
18
 
28
19
  ```bash
29
20
  wadah open
@@ -31,27 +22,67 @@ wadah add "Fix login issue"
31
22
  wadah complete <task-id>
32
23
  ```
33
24
 
34
- ## Useful Commands
25
+ ## Commands
26
+
27
+ | Command | Description |
28
+ |--------|-------------|
29
+ | **Auth** | `login`, `signup`, `logout`, `whoami` |
30
+ | **Tasks** | `open`, `list`, `requested`, `add`, `complete`, `reopen`, `view`, `update`, `move`, `assign`, `comment`, `delete` |
31
+ | **Board** | `boards`, `buckets`, `assignees`; `board create/delete`, `bucket create/update/delete`, `assignee create/update/delete` |
32
+ | **Files** | `folders`, `files`, `folder create` / `mkdir`, `upload` |
33
+ | **Calendar** | `calendar` (list; `--assignee`, `--task`, `--from`, `--to`), `calendar add`, `calendar update <id>`, `calendar delete <id>` |
34
+ | **Docs** | `docs` (list), `doc create [title]`, `doc show <id>`, `doc update <id>`, `doc delete <id>` |
35
+ | **Agent tokens** | `agent-tokens` (list), `agent-token create [name]`, `agent-token delete <id>` |
36
+ | **Workspace** | `state`, `members`, `invite`, `config` |
37
+ | **Other** | `do "<sentence>"` (natural language, needs `OPENAI_API_KEY`), `doctor`, `completion [bash\|zsh]` |
38
+
39
+ Run `wadah --help` for full list and options.
40
+
41
+ ## Shell completion
35
42
 
36
- - `wadah --help`
37
- - `wadah whoami`
38
- - `wadah list --open`
39
- - `wadah move <task-id> <bucket>`
40
- - `wadah update <task-id> --title "New title"`
41
- - `wadah state`
43
+ **Bash:**
42
44
 
43
- ## API URL Override
45
+ ```bash
46
+ wadah completion bash >> ~/.bashrc
47
+ source ~/.bashrc
48
+ ```
44
49
 
45
- Use env var:
50
+ **Zsh:**
46
51
 
47
52
  ```bash
48
- TASK_MANAGER_API_URL=https://api.openwadah.com wadah open
53
+ wadah completion zsh >> ~/.zshrc
54
+ source ~/.zshrc
49
55
  ```
50
56
 
51
- Or pass per command:
57
+ ## Agent / AI use
58
+
59
+ - Set `TASK_MANAGER_TOKEN` (create a token in the app under **Agent access**).
60
+ - Use `--json` for machine-readable output: `wadah open --json`, `wadah list --json`.
61
+ - Natural language: `wadah do "add a task to fix the bug"` (requires `OPENAI_API_KEY`).
62
+ - In Cursor/Claude/Kimi: see **WADAH_CLI.md** in the repo root for a short reference.
63
+
64
+ ## Global flags
65
+
66
+ - `--api <url>` — API base URL
67
+ - `--profile <name>` — config profile
68
+ - `--token <token>` — auth token for this run
69
+ - `--json` — JSON output
70
+ - `--quiet` — minimal output
71
+
72
+ ## Develop & test
73
+
74
+ From the repo root:
52
75
 
53
76
  ```bash
54
- wadah --api https://api.openwadah.com open
77
+ npm run install:all
78
+ npm run tm -- --help
79
+ cd task-manager-cli && npm test
55
80
  ```
56
81
 
57
- Use your own API URL if self-hosting (for example `https://api.yourcompany.com`).
82
+ ## Error codes (with `--json`)
83
+
84
+ - `auth_error` — not authenticated
85
+ - `validation_error` — bad input
86
+ - `network_error` — request failed
87
+ - `api_error` — API returned an error
88
+ - `config` — missing config (e.g. OPENAI_API_KEY for `do`)