smashspace 0.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 ADDED
@@ -0,0 +1,84 @@
1
+ # smashspace
2
+
3
+ The **SmashSpace** command-line client and MCP server — operate your boards
4
+ from the terminal, and let Claude Code / Cursor / Codex read and write the same
5
+ cards.
6
+
7
+ SmashSpace is a Cloudflare-native Kanban where people work in the UI and AI
8
+ agents work through the CLI, MCP, and HTTP API on the *same* data. See
9
+ <https://smashspace.app>.
10
+
11
+ > This package is the **client** for the hosted SmashSpace service. It is not
12
+ > the server, and it is not open source.
13
+
14
+ ## Install
15
+
16
+ ```bash
17
+ npm i -g smashspace
18
+ ```
19
+
20
+ ## Sign in (approve in the browser — no copy/paste)
21
+
22
+ ```bash
23
+ smash login
24
+ ```
25
+
26
+ Your browser opens; click **承認して CLI に接続 / Approve & connect the CLI**.
27
+ The token is delivered to a local loopback port and saved to
28
+ `~/.config/smash/credentials.json`. The same credential is used by the MCP
29
+ server below. (Headless? use `smash login --token <PAT>`.)
30
+
31
+ ## Project config: `.smashspace.json`
32
+
33
+ Drop this at your repo root so `smash` knows which board to operate on:
34
+
35
+ ```json
36
+ {
37
+ "base_url": "https://smashspace.app",
38
+ "default": "main",
39
+ "boards": {
40
+ "main": { "board_id": "b_xxxxxxxx", "comment": "Team board" }
41
+ }
42
+ }
43
+ ```
44
+
45
+ ## Everyday commands
46
+
47
+ ```bash
48
+ smash read # show the board (lists + cards)
49
+ smash scan --list "やること" # actionable cards as JSON (for agents)
50
+ smash create "Fix signup bug" # add a card (to the first list, or --list)
51
+ smash move <cardId> "レビュー" # move a card to a list by name
52
+ smash archive <cardId> # archive (soft-delete) a card
53
+ smash --help # full command list (board/list/card/…)
54
+ ```
55
+
56
+ Pick a board with `-b <label>` (defaults to `main`), or bypass config with
57
+ `--board-id <id>`.
58
+
59
+ > `smash space …` is an alias of `smash board …`, and the HTTP API mirrors
60
+ > `/api/boards` at `/api/spaces`. In `.smashspace.json`, `space_id` / `spaces`
61
+ > also work as aliases for `board_id` / `boards`.
62
+
63
+ ## MCP (Claude Code / Cursor / Codex)
64
+
65
+ ```json
66
+ {
67
+ "mcpServers": {
68
+ "smashspace": {
69
+ "command": "smashspace-mcp",
70
+ "env": {
71
+ "SMASH_BASE_URL": "https://smashspace.app",
72
+ "SMASH_BOARDS": "https://smashspace.app/board/b_xxxxxxxx"
73
+ }
74
+ }
75
+ }
76
+ }
77
+ ```
78
+
79
+ The MCP server exposes `smash_*` tools (get/create/move cards, comments,
80
+ checklists, …) and reads the same token from `smash login`.
81
+
82
+ ---
83
+
84
+ © SmashSpace. All rights reserved.