ctxbin 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 CHANGED
@@ -13,11 +13,11 @@ so agents consistently save and load branch context.
13
13
  - Add: [`agent-addon.md`](agent-addon.md) → copy the block into your project's agent instruction file
14
14
  (e.g. `AGENT.md`, `CLAUDE.md`, or any equivalent).
15
15
  - Then you can simply ask:
16
- - “Use ctxbin to save the current context.”
17
- - “Use ctxbin to load the current context.”
16
+ - “Use npx ctxbin to save the current context.”
17
+ - “Use npx ctxbin to load the current context.”
18
18
 
19
19
  The add-on tells agents how to format context (summary, next steps, decisions) and how to use
20
- `ctxbin ctx save/load` correctly.
20
+ `npx ctxbin ctx save/load` correctly.
21
21
 
22
22
  ## Features
23
23
  - Branch-scoped `ctx` keys (auto-inferred from git repo + branch)
@@ -58,10 +58,10 @@ npx ctxbin init
58
58
  ## Quick usage
59
59
  ### ctx (branch-scoped, key optional in git repos)
60
60
  ```bash
61
- ctxbin ctx save --value "summary / next steps"
62
- ctxbin ctx load
63
- ctxbin ctx list
64
- ctxbin ctx delete
61
+ npx ctxbin ctx save --value "summary / next steps"
62
+ npx ctxbin ctx load
63
+ npx ctxbin ctx list
64
+ npx ctxbin ctx delete
65
65
  ```
66
66
 
67
67
  When the key is omitted, ctxbin infers it **only inside a git repository**:
@@ -73,42 +73,42 @@ branch = git rev-parse --abbrev-ref HEAD
73
73
 
74
74
  Explicit key example (useful outside git repos; not recommended for normal use):
75
75
  ```bash
76
- ctxbin ctx save my-project/main --value "summary / next steps"
77
- ctxbin ctx load my-project/main
78
- ctxbin ctx delete my-project/main
76
+ npx ctxbin ctx save my-project/main --value "summary / next steps"
77
+ npx ctxbin ctx load my-project/main
78
+ npx ctxbin ctx delete my-project/main
79
79
  ```
80
80
 
81
81
  ### agent (string-only)
82
82
  ```bash
83
- ctxbin agent save reviewer --value "# Agent role"
84
- ctxbin agent load reviewer
85
- ctxbin agent list
86
- ctxbin agent delete reviewer
83
+ npx ctxbin agent save reviewer --value "# Agent role"
84
+ npx ctxbin agent load reviewer
85
+ npx ctxbin agent list
86
+ npx ctxbin agent delete reviewer
87
87
  ```
88
88
 
89
89
  ### skill (string, skillpack, or skillref)
90
90
  ```bash
91
- ctxbin skill save my-skill --value "# Skill markdown"
92
- ctxbin skill load my-skill
93
- ctxbin skill list
94
- ctxbin skill delete my-skill
91
+ npx ctxbin skill save my-skill --value "# Skill markdown"
92
+ npx ctxbin skill load my-skill
93
+ npx ctxbin skill list
94
+ npx ctxbin skill delete my-skill
95
95
  ```
96
96
 
97
97
  Skillpack (directory bundle):
98
98
  ```bash
99
- ctxbin skill save fp-pack --dir ./skills/fp-pack
100
- ctxbin skill load fp-pack --dir ./tmp/fp-pack
99
+ npx ctxbin skill save fp-pack --dir ./skills/fp-pack
100
+ npx ctxbin skill load fp-pack --dir ./tmp/fp-pack
101
101
  ```
102
102
 
103
103
  Skillref (GitHub directory reference):
104
104
  ```bash
105
105
  # Track default branch
106
- ctxbin skill save fp-pack \
106
+ npx ctxbin skill save fp-pack \
107
107
  --url https://github.com/OWNER/REPO \
108
108
  --path skills/fp-pack
109
109
 
110
110
  # Pin to a commit
111
- ctxbin skill save fp-pack \
111
+ npx ctxbin skill save fp-pack \
112
112
  --url https://github.com/OWNER/REPO \
113
113
  --ref <40-hex-commit-sha> \
114
114
  --path skills/fp-pack
package/agent-addon.md CHANGED
@@ -6,7 +6,8 @@ Copy/paste the block between the markers below into your AGENT.md / CLAUDE.md.
6
6
 
7
7
  ## ctxbin (Context Persistence)
8
8
 
9
- Use `ctxbin ctx save` to store **branch‑scoped context** so the next agent can continue without re‑explanation.
9
+ Use `npx ctxbin ...` when running commands in agent workflows.
10
+ Use `npx ctxbin ctx save` to store **branch‑scoped context** so the next agent can continue without re‑explanation.
10
11
  > Tip: `npx ctxbin skill load ctxbin` prints the bundled ctxbin skill text
11
12
  > so agents can reference the full ctxbin guidance.
12
13
 
@@ -19,17 +20,17 @@ branch = git rev-parse --abbrev-ref HEAD
19
20
 
20
21
  ### Save context (preferred)
21
22
  ```bash
22
- ctxbin ctx save --value "<summary + next steps + decisions>"
23
+ npx ctxbin ctx save --value "<summary + next steps + decisions>"
23
24
  ```
24
25
 
25
26
  ### Save via stdin
26
27
  ```bash
27
- echo "<context>" | ctxbin ctx save
28
+ echo "<context>" | npx ctxbin ctx save
28
29
  ```
29
30
 
30
31
  ### Load context
31
32
  ```bash
32
- ctxbin ctx load
33
+ npx ctxbin ctx load
33
34
  ```
34
35
 
35
36
  ### What to include in ctx
@@ -6,7 +6,8 @@ Copy/paste the block between the markers below into your AGENT.md / CLAUDE.md.
6
6
 
7
7
  ## ctxbin (Context Persistence)
8
8
 
9
- Use `ctxbin ctx save` to store **branch‑scoped context** so the next agent can continue without re‑explanation.
9
+ Use `npx ctxbin ...` when running commands in agent workflows.
10
+ Use `npx ctxbin ctx save` to store **branch‑scoped context** so the next agent can continue without re‑explanation.
10
11
  > Tip: `npx ctxbin skill load ctxbin` prints the bundled ctxbin skill text
11
12
  > so agents can reference the full ctxbin guidance.
12
13
 
@@ -19,17 +20,17 @@ branch = git rev-parse --abbrev-ref HEAD
19
20
 
20
21
  ### Save context (preferred)
21
22
  ```bash
22
- ctxbin ctx save --value "<summary + next steps + decisions>"
23
+ npx ctxbin ctx save --value "<summary + next steps + decisions>"
23
24
  ```
24
25
 
25
26
  ### Save via stdin
26
27
  ```bash
27
- echo "<context>" | ctxbin ctx save
28
+ echo "<context>" | npx ctxbin ctx save
28
29
  ```
29
30
 
30
31
  ### Load context
31
32
  ```bash
32
- ctxbin ctx load
33
+ npx ctxbin ctx load
33
34
  ```
34
35
 
35
36
  ### What to include in ctx
@@ -3,7 +3,7 @@ name: ctxbin
3
3
  description: Use when working with ctxbin to save and load ctx, agent, and skill context.
4
4
  metadata:
5
5
  short-description: ctxbin workflow
6
- version: 0.1.0
6
+ version: 0.1.1
7
7
  ---
8
8
 
9
9
  # ctxbin Skill
@@ -13,6 +13,7 @@ Help agents preserve and restore **branch-scoped project context** so the next a
13
13
 
14
14
  ## Core Usage (ctx)
15
15
  `ctx` automatically derives a key from the current Git repo and branch when omitted.
16
+ Prefer `npx ctxbin ...` when running commands in agent workflows.
16
17
 
17
18
  ```
18
19
  key = {project}/{branch}
@@ -22,54 +23,54 @@ branch = git rev-parse --abbrev-ref HEAD
22
23
 
23
24
  ### Save (most common)
24
25
  ```bash
25
- ctxbin ctx save --value "summary / next steps / notes"
26
+ npx ctxbin ctx save --value "summary / next steps / notes"
26
27
  ```
27
28
  Or via stdin:
28
29
  ```bash
29
- echo "summary" | ctxbin ctx save
30
+ echo "summary" | npx ctxbin ctx save
30
31
  ```
31
32
 
32
33
  ### Load
33
34
  ```bash
34
- ctxbin ctx load
35
+ npx ctxbin ctx load
35
36
  ```
36
37
 
37
38
  ### List
38
39
  ```bash
39
- ctxbin ctx list
40
+ npx ctxbin ctx list
40
41
  ```
41
42
 
42
43
  ### Delete
43
44
  ```bash
44
- ctxbin ctx delete
45
+ npx ctxbin ctx delete
45
46
  ```
46
47
 
47
48
  ## agent Save/Load
48
49
  `agent` requires a key and stores **string values only**.
49
50
 
50
51
  ```bash
51
- ctxbin agent save reviewer --value "# Agent role"
52
- ctxbin agent load reviewer
52
+ npx ctxbin agent save reviewer --value "# Agent role"
53
+ npx ctxbin agent load reviewer
53
54
  ```
54
55
 
55
56
  ### List/Delete
56
57
  ```bash
57
- ctxbin agent list
58
- ctxbin agent delete reviewer
58
+ npx ctxbin agent list
59
+ npx ctxbin agent delete reviewer
59
60
  ```
60
61
 
61
62
  ## skill Save/Load
62
63
  `skill` requires a key.
63
64
 
64
65
  ```bash
65
- ctxbin skill save my-skill --value "# Skill markdown"
66
- ctxbin skill load my-skill
66
+ npx ctxbin skill save my-skill --value "# Skill markdown"
67
+ npx ctxbin skill load my-skill
67
68
  ```
68
69
 
69
70
  ### List/Delete
70
71
  ```bash
71
- ctxbin skill list
72
- ctxbin skill delete my-skill
72
+ npx ctxbin skill list
73
+ npx ctxbin skill delete my-skill
73
74
  ```
74
75
 
75
76
  ## Input Options (`--file`, `--value`, `--dir`, `--url`)
@@ -77,34 +78,34 @@ Use **exactly one** input method.
77
78
 
78
79
  - `--value`: store a literal string
79
80
  ```bash
80
- ctxbin ctx save --value "summary"
81
- ctxbin agent save reviewer --value "# Agent role"
82
- ctxbin skill save my-skill --value "# Skill markdown"
81
+ npx ctxbin ctx save --value "summary"
82
+ npx ctxbin agent save reviewer --value "# Agent role"
83
+ npx ctxbin skill save my-skill --value "# Skill markdown"
83
84
  ```
84
85
 
85
86
  - `--file`: store file contents
86
87
  ```bash
87
- ctxbin ctx save --file context.md
88
- ctxbin agent save reviewer --file agent.md
89
- ctxbin skill save my-skill --file SKILL.md
88
+ npx ctxbin ctx save --file context.md
89
+ npx ctxbin agent save reviewer --file agent.md
90
+ npx ctxbin skill save my-skill --file SKILL.md
90
91
  ```
91
92
 
92
93
  - `--dir`: store a directory as a skillpack (skill-only)
93
94
  ```bash
94
- ctxbin skill save my-skill --dir ./skills/my-skill
95
- ctxbin skill load my-skill --dir ./tmp/my-skill
95
+ npx ctxbin skill save my-skill --dir ./skills/my-skill
96
+ npx ctxbin skill load my-skill --dir ./tmp/my-skill
96
97
  ```
97
98
 
98
99
  - `--url` (+ `--path`, optional `--ref`): GitHub directory reference (skill-only)
99
100
  ```bash
100
101
  # Pin to a specific commit
101
- ctxbin skill save my-skill \
102
+ npx ctxbin skill save my-skill \
102
103
  --url https://github.com/OWNER/REPO \
103
104
  --ref <40-hex-commit-sha> \
104
105
  --path skills/my-skill
105
106
 
106
107
  # Track default branch (omit --ref)
107
- ctxbin skill save my-skill \
108
+ npx ctxbin skill save my-skill \
108
109
  --url https://github.com/OWNER/REPO \
109
110
  --path skills/my-skill
110
111
  ```
@@ -113,9 +114,9 @@ Use **exactly one** input method.
113
114
  `--append` works with **string inputs only**.
114
115
 
115
116
  ```bash
116
- ctxbin ctx save --append --value "more notes"
117
- ctxbin agent save reviewer --append --value "extra role details"
118
- ctxbin skill save my-skill --append --value "extra string"
117
+ npx ctxbin ctx save --append --value "more notes"
118
+ npx ctxbin agent save reviewer --append --value "extra role details"
119
+ npx ctxbin skill save my-skill --append --value "extra string"
119
120
  ```
120
121
 
121
122
  ## What agents must include in ctx
@@ -134,4 +135,3 @@ Context is stored in Upstash Redis hash `ctx` under field `{project}/{branch}`.
134
135
  ## Do Not
135
136
  - Don’t store secrets
136
137
  - Don’t overwrite with trivial messages
137
-
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ctxbin",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Minimal deterministic CLI to store/load context, agents, and skills via Redis hashes",
5
5
  "author": "superlucky84",
6
6
  "license": "MIT",
@@ -44,6 +44,9 @@
44
44
  },
45
45
  "scripts": {
46
46
  "build": "tsup && node scripts/copy-skills.js",
47
- "test": "pnpm build && node --test \"tests/**/*.test.js\""
47
+ "test": "pnpm build && node --test \"tests/**/*.test.js\"",
48
+ "clean": "pnpm clean:dist && pnpm clean:module",
49
+ "clean:dist": "rm -rf dist docs/dist",
50
+ "clean:module": "rm -rf dist docs/dist node_modules"
48
51
  }
49
52
  }
@@ -5,6 +5,7 @@ Help agents preserve and restore **branch-scoped project context** so the next a
5
5
 
6
6
  ## Core Usage (ctx)
7
7
  `ctx` automatically derives a key from the current Git repo and branch when omitted.
8
+ Prefer `npx ctxbin ...` when running commands in agent workflows.
8
9
 
9
10
  ```
10
11
  key = {project}/{branch}
@@ -14,54 +15,54 @@ branch = git rev-parse --abbrev-ref HEAD
14
15
 
15
16
  ### Save (most common)
16
17
  ```bash
17
- ctxbin ctx save --value "summary / next steps / notes"
18
+ npx ctxbin ctx save --value "summary / next steps / notes"
18
19
  ```
19
20
  Or via stdin:
20
21
  ```bash
21
- echo "summary" | ctxbin ctx save
22
+ echo "summary" | npx ctxbin ctx save
22
23
  ```
23
24
 
24
25
  ### Load
25
26
  ```bash
26
- ctxbin ctx load
27
+ npx ctxbin ctx load
27
28
  ```
28
29
 
29
30
  ### List
30
31
  ```bash
31
- ctxbin ctx list
32
+ npx ctxbin ctx list
32
33
  ```
33
34
 
34
35
  ### Delete
35
36
  ```bash
36
- ctxbin ctx delete
37
+ npx ctxbin ctx delete
37
38
  ```
38
39
 
39
40
  ## agent Save/Load
40
41
  `agent` requires a key and stores **string values only**.
41
42
 
42
43
  ```bash
43
- ctxbin agent save reviewer --value "# Agent role"
44
- ctxbin agent load reviewer
44
+ npx ctxbin agent save reviewer --value "# Agent role"
45
+ npx ctxbin agent load reviewer
45
46
  ```
46
47
 
47
48
  ### List/Delete
48
49
  ```bash
49
- ctxbin agent list
50
- ctxbin agent delete reviewer
50
+ npx ctxbin agent list
51
+ npx ctxbin agent delete reviewer
51
52
  ```
52
53
 
53
54
  ## skill Save/Load
54
55
  `skill` requires a key.
55
56
 
56
57
  ```bash
57
- ctxbin skill save my-skill --value "# Skill markdown"
58
- ctxbin skill load my-skill
58
+ npx ctxbin skill save my-skill --value "# Skill markdown"
59
+ npx ctxbin skill load my-skill
59
60
  ```
60
61
 
61
62
  ### List/Delete
62
63
  ```bash
63
- ctxbin skill list
64
- ctxbin skill delete my-skill
64
+ npx ctxbin skill list
65
+ npx ctxbin skill delete my-skill
65
66
  ```
66
67
 
67
68
  ## Input Options (`--file`, `--value`, `--dir`, `--url`)
@@ -69,34 +70,34 @@ Use **exactly one** input method.
69
70
 
70
71
  - `--value`: store a literal string
71
72
  ```bash
72
- ctxbin ctx save --value "summary"
73
- ctxbin agent save reviewer --value "# Agent role"
74
- ctxbin skill save my-skill --value "# Skill markdown"
73
+ npx ctxbin ctx save --value "summary"
74
+ npx ctxbin agent save reviewer --value "# Agent role"
75
+ npx ctxbin skill save my-skill --value "# Skill markdown"
75
76
  ```
76
77
 
77
78
  - `--file`: store file contents
78
79
  ```bash
79
- ctxbin ctx save --file context.md
80
- ctxbin agent save reviewer --file agent.md
81
- ctxbin skill save my-skill --file SKILL.md
80
+ npx ctxbin ctx save --file context.md
81
+ npx ctxbin agent save reviewer --file agent.md
82
+ npx ctxbin skill save my-skill --file SKILL.md
82
83
  ```
83
84
 
84
85
  - `--dir`: store a directory as a skillpack (skill-only)
85
86
  ```bash
86
- ctxbin skill save my-skill --dir ./skills/my-skill
87
- ctxbin skill load my-skill --dir ./tmp/my-skill
87
+ npx ctxbin skill save my-skill --dir ./skills/my-skill
88
+ npx ctxbin skill load my-skill --dir ./tmp/my-skill
88
89
  ```
89
90
 
90
91
  - `--url` (+ `--path`, optional `--ref`): GitHub directory reference (skill-only)
91
92
  ```bash
92
93
  # Pin to a specific commit
93
- ctxbin skill save my-skill \
94
+ npx ctxbin skill save my-skill \
94
95
  --url https://github.com/OWNER/REPO \
95
96
  --ref <40-hex-commit-sha> \
96
97
  --path skills/my-skill
97
98
 
98
99
  # Track default branch (omit --ref)
99
- ctxbin skill save my-skill \
100
+ npx ctxbin skill save my-skill \
100
101
  --url https://github.com/OWNER/REPO \
101
102
  --path skills/my-skill
102
103
  ```
@@ -105,9 +106,9 @@ Use **exactly one** input method.
105
106
  `--append` works with **string inputs only**.
106
107
 
107
108
  ```bash
108
- ctxbin ctx save --append --value "more notes"
109
- ctxbin agent save reviewer --append --value "extra role details"
110
- ctxbin skill save my-skill --append --value "extra string"
109
+ npx ctxbin ctx save --append --value "more notes"
110
+ npx ctxbin agent save reviewer --append --value "extra role details"
111
+ npx ctxbin skill save my-skill --append --value "extra string"
111
112
  ```
112
113
 
113
114
  ## What agents must include in ctx
@@ -126,4 +127,3 @@ Context is stored in Upstash Redis hash `ctx` under field `{project}/{branch}`.
126
127
  ## Do Not
127
128
  - Don’t store secrets
128
129
  - Don’t overwrite with trivial messages
129
-