slimwiki 0.1.1 → 0.1.2
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 +5 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Agent-friendly CLI for [SlimWiki](https://slimwiki.com). Lets a human or an
|
|
4
4
|
AI agent sign in to a SlimWiki account, browse pages, and create new
|
|
5
|
-
ones from
|
|
5
|
+
ones from a JSON document.
|
|
6
6
|
|
|
7
7
|
## Install
|
|
8
8
|
|
|
@@ -47,7 +47,7 @@ The CLI ships two artefacts so agents can learn its contract without
|
|
|
47
47
|
you re-explaining each session:
|
|
48
48
|
|
|
49
49
|
- **`AGENT.md`** — agent-agnostic contract: command surface, JSON
|
|
50
|
-
output shape,
|
|
50
|
+
output shape, document schema, failure modes, recipes.
|
|
51
51
|
- **`SKILL.md`** — Claude Code skill stub with frontmatter.
|
|
52
52
|
- **`slimwiki agent-help`** — prints `AGENT.md` to stdout for sandboxed
|
|
53
53
|
agents that can't read files.
|
|
@@ -101,7 +101,7 @@ slimwiki page list [--account <slug>] [--wiki <slug>]
|
|
|
101
101
|
|
|
102
102
|
slimwiki page get <slug-or-pageHash-or-id>
|
|
103
103
|
[--account <slug>] [--wiki <slug>]
|
|
104
|
-
# → full page row including
|
|
104
|
+
# → full page row including the document body
|
|
105
105
|
|
|
106
106
|
slimwiki page create --title <title>
|
|
107
107
|
(--file <path> | --content <jsonString> | --stdin)
|
|
@@ -127,7 +127,7 @@ Defaults for `--account` / `--wiki`, in order:
|
|
|
127
127
|
|
|
128
128
|
If the user belongs to exactly one account, no flags are required.
|
|
129
129
|
|
|
130
|
-
##
|
|
130
|
+
## Document contract
|
|
131
131
|
|
|
132
132
|
`page create` accepts a single object of shape
|
|
133
133
|
`{ "type": "doc", "content": [...] }`. The CLI validates locally before
|
|
@@ -174,7 +174,7 @@ truth that agents read.
|
|
|
174
174
|
|
|
175
175
|
## Recipes
|
|
176
176
|
|
|
177
|
-
### Create a page from
|
|
177
|
+
### Create a page from a JSON document
|
|
178
178
|
|
|
179
179
|
```sh
|
|
180
180
|
slimwiki page create --title "Apple varieties" --stdin <<'JSON'
|
package/package.json
CHANGED