@memfork/cli 0.1.0 → 0.1.1
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 +109 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
# @memfork/cli
|
|
2
|
+
|
|
3
|
+
Command-line interface for [MemForks](https://github.com/memfork/memforks) — on-chain, branch-aware agent memory.
|
|
4
|
+
|
|
5
|
+
Initialize a memory tree, commit facts, branch and merge, onboard teammates, and install IDE plugins.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install -g @memfork/cli
|
|
11
|
+
# or run without installing
|
|
12
|
+
npx @memfork/cli init
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Quick start
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
# One-shot setup on mainnet (gas sponsored — no SUI required)
|
|
19
|
+
memfork init
|
|
20
|
+
|
|
21
|
+
# Verify everything works
|
|
22
|
+
memfork doctor
|
|
23
|
+
|
|
24
|
+
# Install Cursor plugin (MemWal MCP + MemForks rules)
|
|
25
|
+
memfork install cursor
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Restart your IDE. The agent recalls and commits memory scoped to your Git branch.
|
|
29
|
+
|
|
30
|
+
## Commands
|
|
31
|
+
|
|
32
|
+
### Setup
|
|
33
|
+
|
|
34
|
+
| Command | Description |
|
|
35
|
+
|---------|-------------|
|
|
36
|
+
| `memfork init` | Interactive setup — create or link a memory tree |
|
|
37
|
+
| `memfork init --quick` | Auto-provision key, MemWal account, and tree (testnet) |
|
|
38
|
+
| `memfork join` | Onboard to an existing tree (team member) |
|
|
39
|
+
| `memfork doctor` | Verify config, RPC, credentials, and on-chain state |
|
|
40
|
+
| `memfork install cursor` | Install Cursor MCP + rules |
|
|
41
|
+
| `memfork install codex` | Install Codex plugin scaffold |
|
|
42
|
+
|
|
43
|
+
### Memory operations
|
|
44
|
+
|
|
45
|
+
| Command | Description |
|
|
46
|
+
|---------|-------------|
|
|
47
|
+
| `memfork status` | Tree, network, branch, signer |
|
|
48
|
+
| `memfork log` | Recent commits on a branch |
|
|
49
|
+
| `memfork recall <query>` | Semantic recall from CLI |
|
|
50
|
+
| `memfork commit -m "…" --facts "…"` | Anchor facts on-chain |
|
|
51
|
+
| `memfork branch <name>` | Create a new branch |
|
|
52
|
+
| `memfork checkout <name>` | Switch active branch |
|
|
53
|
+
| `memfork diff <a> <b>` | Fact diff between branches |
|
|
54
|
+
| `memfork merge <from> <into> --resolver <id>` | Propose a merge |
|
|
55
|
+
| `memfork proposals` | List open merge proposals |
|
|
56
|
+
|
|
57
|
+
### Access control
|
|
58
|
+
|
|
59
|
+
| Command | Description |
|
|
60
|
+
|---------|-------------|
|
|
61
|
+
| `memfork grant --agent <addr>` | Grant on-chain delegate access |
|
|
62
|
+
| `memfork grant-memwal --agent <addr> --pubkey <hex>` | Register MemWal decrypt key |
|
|
63
|
+
| `memfork revoke --agent <addr>` | Revoke delegate |
|
|
64
|
+
| `memfork delegates` | List current delegates |
|
|
65
|
+
|
|
66
|
+
## Config files
|
|
67
|
+
|
|
68
|
+
| File | Committable? | Contents |
|
|
69
|
+
|------|--------------|----------|
|
|
70
|
+
| `.memfork/config.json` | Yes | `treeId`, `network`, `defaultBranch` |
|
|
71
|
+
| `~/.memfork/credentials.json` | No | Private keys, MemWal delegate key |
|
|
72
|
+
|
|
73
|
+
Never commit credentials. Share `.memfork/config.json` via git so teammates can `memfork join`.
|
|
74
|
+
|
|
75
|
+
## Team onboarding
|
|
76
|
+
|
|
77
|
+
**Teammate:**
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
git clone <repo> # .memfork/config.json is already there
|
|
81
|
+
memfork join
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
**Tree owner** (runs the printed commands):
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
memfork grant --agent <teammate-address>
|
|
88
|
+
memfork grant-memwal --agent <teammate-address> --pubkey <hex>
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
## Environment variables
|
|
92
|
+
|
|
93
|
+
| Variable | Description |
|
|
94
|
+
|----------|-------------|
|
|
95
|
+
| `MEMFORK_TREE_ID` | MemoryTree object ID |
|
|
96
|
+
| `MEMFORK_PRIVATE_KEY` | Sui private key (`suiprivkey1…`) |
|
|
97
|
+
| `MEMFORK_NETWORK` | `mainnet` (default) or `testnet` |
|
|
98
|
+
| `MEMFORK_SPONSOR_URL` | Gas sponsor service URL |
|
|
99
|
+
| `MEMFORK_PACKAGE_ID` | Override Move package ID |
|
|
100
|
+
|
|
101
|
+
## Links
|
|
102
|
+
|
|
103
|
+
- [@memfork/core](https://www.npmjs.com/package/@memfork/core) — TypeScript SDK
|
|
104
|
+
- [Developer guide](https://github.com/memfork/memforks/blob/main/docs/developer-guide.md)
|
|
105
|
+
- [Git comparison](https://github.com/memfork/memforks/blob/main/docs/git-comparison.md)
|
|
106
|
+
|
|
107
|
+
## License
|
|
108
|
+
|
|
109
|
+
Apache-2.0
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@memfork/cli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "MemForks CLI — init, commit, recall, merge, install plugins",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
],
|
|
25
25
|
"dependencies": {
|
|
26
26
|
"@inquirer/prompts": "^8.5.2",
|
|
27
|
-
"@memfork/core": "^0.1.
|
|
27
|
+
"@memfork/core": "^0.1.1",
|
|
28
28
|
"chalk": "^5.6.2",
|
|
29
29
|
"commander": "^15.0.0"
|
|
30
30
|
},
|