@ideaspaces/cli 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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 IdeaSpaces
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,113 @@
1
+ # ideaspaces
2
+
3
+ > Persistent, searchable knowledge from the command line.
4
+
5
+ `ideaspaces` is the CLI for [IdeaSpaces](https://ideaspaces.xyz) — a place where teams of people and agents maintain shared understanding. A **space** is a git repository where knowledge compounds: notes are state, conversations are process, and the directory tree is how you navigate. This CLI is the fastest way to work with a space: clone it locally, edit and capture, search, push and pull, and talk to an agent — online or fully local.
6
+
7
+ ## Install
8
+
9
+ ```sh
10
+ npm install -g @ideaspaces/cli
11
+ ```
12
+
13
+ This installs the `ideaspaces` command. Node 20+ is required.
14
+
15
+ ## Quick start
16
+
17
+ ```sh
18
+ ideaspaces login # authenticate
19
+ ideaspaces clone alice/notes # clone a space to a local working copy
20
+ cd notes
21
+ ideaspaces navigate . # orient: what's here, what changed
22
+ ideaspaces write ideas.md # edit a note
23
+ ideaspaces commit -m "…" ideas.md # save the capture
24
+ ideaspaces push # send your commits to the remote
25
+ ideaspaces pull # integrate others' changes
26
+ ```
27
+
28
+ Everything is local-first: your working copy is a real git clone on disk. Edits are yours until you `push`.
29
+
30
+ ## Commands
31
+
32
+ Run `ideaspaces <command> --help` for full usage. `--json` is available on most read commands for scripting.
33
+
34
+ ### Spaces & content
35
+ | Command | What it does |
36
+ |---|---|
37
+ | `clone <namespace/slug> [dir]` | Clone a space into a local working copy |
38
+ | `clones` | List your local working copies |
39
+ | `create <name>` | Create a new space |
40
+ | `repos` | List spaces you can access |
41
+ | `link <dir> <namespace/slug>` | Bind an existing local directory to a space |
42
+
43
+ ### Editing & capture
44
+ | Command | What it does |
45
+ |---|---|
46
+ | `write <path>` | Create or edit a note |
47
+ | `node <path>` | Read a single node (file) with its metadata |
48
+ | `change` | Open a mutable capture (a tracked change set) |
49
+ | `commit` | Commit captured changes with attribution trailers |
50
+
51
+ ### Sync & publish
52
+ | Command | What it does |
53
+ |---|---|
54
+ | `push` | Send your committed captures to the remote |
55
+ | `pull` | Integrate remote changes into your local copy |
56
+ | `publish` | Publish a local space to the server |
57
+
58
+ ### Navigate & search
59
+ | Command | What it does |
60
+ |---|---|
61
+ | `navigate <path>` | Orient at a position — contract, awareness, what changed |
62
+ | `catalog` | List the nodes at a position |
63
+ | `ls [<path>]` | List files and folders under a path, typed (folder / repo / ideaspace) |
64
+ | `search <query>` | Full-text search (filename + BM25) over the local clone |
65
+ | `status` | Working-copy status (ahead / behind / dirty) |
66
+ | `skills` | List the skill catalog, or print one skill's markdown |
67
+
68
+ ### Collaborate
69
+ | Command | What it does |
70
+ |---|---|
71
+ | `conversation` | Start or continue a conversation (online or `--local`) |
72
+ | `conversations` | List conversations |
73
+ | `share` | Manage members, invites, and public links |
74
+ | `agents` | List agents available to you |
75
+ | `times` | Activity timeline |
76
+
77
+ ### Identity
78
+ | Command | What it does |
79
+ |---|---|
80
+ | `login` | Authenticate and store credentials |
81
+ | `whoami` | Show the current identity |
82
+ | `forget` | Remove stored credentials |
83
+ | `power logout` | Log out and clear stored credentials |
84
+ | `credential` | Git credential helper (used by git under the hood) |
85
+
86
+ ### Local agent (Pi)
87
+ Run an agent over your local working copy — offline, on your own key.
88
+ | Command | What it does |
89
+ |---|---|
90
+ | `pi-status` | Is a local agent runtime available and configured? |
91
+ | `pi-login` | Configure a model provider (writes the local agent's credentials) |
92
+ | `pi-logout` | Remove a configured model provider |
93
+ | `pi-models` | List the models a configured provider offers |
94
+ | `conversation send --local` | Run a local agent turn over a folder |
95
+
96
+ ## Configuration
97
+
98
+ | Path | What |
99
+ |---|---|
100
+ | `~/.ideaspaces/credentials.json` | Your API credentials |
101
+ | `~/.ideaspaces/spaces.json` | Known spaces and their remotes |
102
+ | `~/.pi/agent/auth.json` | Local-agent model-provider credentials |
103
+
104
+ ### Environment variables
105
+ | Variable | What |
106
+ |---|---|
107
+ | `IS_API_KEY` | API key (overrides stored credentials) |
108
+ | `IS_API_URL` | API base URL (defaults to the hosted service) |
109
+ | `IDEASPACES_PI_EXTENSIONS` | Comma-separated extension paths for the local agent |
110
+
111
+ ## License
112
+
113
+ MIT