@ideaspaces/cli 0.1.0 → 0.1.4

package/README.md

@@ -1,8 +1,12 @@
-# ideaspaces
+# IdeaSpaces CLI
 
-> Persistent, searchable knowledge from the command line.
+> Capture durable agent knowledge from the command line.
 
-`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.
+The [Ideaspace Protocol](https://github.com/IdeaSpaces-xyz/ideaspace-protocol) is the open standard for how agents turn useful work into durable, portable knowledge. `ideaspaces` implements the common command-line mechanics: create and orient in a space, write and commit captures safely, then optionally publish, push, or pull.
+
+A **space** is a git repository where knowledge compounds as ordinary Markdown. The CLI keeps the workflow local-first and scriptable; protocol-aware plugins use the protocol directly for local reads and rely on CLI capabilities for platform operations and transitional writes.
+
+Want your agent to follow the standard automatically? Install [IdeaSpaces for Claude Code and Cowork](https://github.com/IdeaSpaces-xyz/claude-code-plugin) or [IdeaSpaces for Pi](https://github.com/IdeaSpaces-xyz/pi-is-space). Use this package directly for terminal workflows, automation, and integration development.
 
 ## Install
 
@@ -15,17 +19,21 @@ This installs the `ideaspaces` command. Node 20+ is required.
 ## Quick start
 
 ```sh
-ideaspaces login                    # authenticate
-ideaspaces clone alice/notes        # clone a space to a local working copy
-cd notes
+ideaspaces create my-space --yes    # create the standard repository shape
+cd my-space
 ideaspaces navigate .               # orient: what's here, what changed
-ideaspaces write ideas.md           # edit a note
-ideaspaces commit -m "…" ideas.md   # save the capture
-ideaspaces push                     # send your commits to the remote
-ideaspaces pull                     # integrate others' changes
+ideaspaces inspect work/Next.md      # deepen one document, summary first
+ideaspaces write decisions/idea.md --content "Idea body text"
+ideaspaces commit -m "Capture idea" decisions/idea.md
+
+# Optional: host or collaborate remotely
+ideaspaces login
+ideaspaces publish
+ideaspaces push
+ideaspaces pull
 ```
 
-Everything is local-first: your working copy is a real git clone on disk. Edits are yours until you `push`.
+Everything is local-first: your working copy is a real git repository on disk. Captures are yours until you choose to publish or push them.
 
 ## Commands
 
@@ -34,7 +42,9 @@ Run `ideaspaces <command> --help` for full usage. `--json` is available on most
 ### Spaces & content
 | Command | What it does |
 |---|---|
-| `clone <namespace/slug> [dir]` | Clone a space into a local working copy |
+| `clone <space-url> [dir]` | Clone an authorized Space by stable identity into a local working copy |
+| `fork <space-url> [dir]` | Create and clone an independent current-content copy without source history |
+| `update [--yes]` | Preview or apply maintained source updates to a fork without displacing local work |
 | `clones` | List your local working copies |
 | `create <name>` | Create a new space |
 | `repos` | List spaces you can access |
@@ -51,14 +61,16 @@ Run `ideaspaces <command> --help` for full usage. `--json` is available on most
 ### Sync & publish
 | Command | What it does |
 |---|---|
+| `sync` | Report where you, the Space, and a fork's recorded source stand — reads only, integrates nothing |
 | `push` | Send your committed captures to the remote |
-| `pull` | Integrate remote changes into your local copy |
+| `pull` | Integrate changes from the fork's own Git remote |
 | `publish` | Publish a local space to the server |
 
 ### Navigate & search
 | Command | What it does |
 |---|---|
 | `navigate <path>` | Orient at a position — contract, awareness, what changed |
+| `inspect <path>` | Inspect one local Markdown file by summary, outline, or selected section |
 | `catalog` | List the nodes at a position |
 | `ls [<path>]` | List files and folders under a path, typed (folder / repo / ideaspace) |
 | `search <query>` | Full-text search (filename + BM25) over the local clone |
@@ -70,7 +82,7 @@ Run `ideaspaces <command> --help` for full usage. `--json` is available on most
 |---|---|
 | `conversation` | Start or continue a conversation (online or `--local`) |
 | `conversations` | List conversations |
-| `share` | Manage members, invites, and public links |
+| `share` | Share a Space at a grade — explore, fork, or collaborate — and see who has it |
 | `agents` | List agents available to you |
 | `times` | Activity timeline |