learnchain 0.3.0 → 0.4.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
|
@@ -52,28 +52,28 @@ LearnChain can generate quizzes with OpenAI, Anthropic, or OpenRouter. Provider
|
|
|
52
52
|
### Option 2: configure keys from the CLI
|
|
53
53
|
|
|
54
54
|
```bash
|
|
55
|
-
learnchain
|
|
56
|
-
learnchain
|
|
57
|
-
learnchain
|
|
55
|
+
learnchain config set openai-key <key>
|
|
56
|
+
learnchain config set anthropic-key <key>
|
|
57
|
+
learnchain config set openrouter-key <key>
|
|
58
58
|
```
|
|
59
59
|
|
|
60
60
|
You can also clear them:
|
|
61
61
|
|
|
62
62
|
```bash
|
|
63
|
-
learnchain
|
|
64
|
-
learnchain
|
|
65
|
-
learnchain
|
|
63
|
+
learnchain config clear openai-key
|
|
64
|
+
learnchain config clear anthropic-key
|
|
65
|
+
learnchain config clear openrouter-key
|
|
66
66
|
```
|
|
67
67
|
|
|
68
68
|
You can also configure a generic deep-dive export destination for future document repository integrations:
|
|
69
69
|
|
|
70
70
|
```bash
|
|
71
|
-
learnchain
|
|
72
|
-
learnchain
|
|
73
|
-
learnchain
|
|
74
|
-
learnchain
|
|
75
|
-
learnchain
|
|
76
|
-
learnchain
|
|
71
|
+
learnchain config set repository notion
|
|
72
|
+
learnchain config set repository-target database/abcd1234
|
|
73
|
+
learnchain config clear repository
|
|
74
|
+
learnchain config clear repository-target
|
|
75
|
+
learnchain config set notion-token <token>
|
|
76
|
+
learnchain config clear notion-token
|
|
77
77
|
```
|
|
78
78
|
|
|
79
79
|
## Codex Integration
|
|
@@ -82,27 +82,27 @@ LearnChain can generate a deep dive for the active Codex session without opening
|
|
|
82
82
|
|
|
83
83
|
Prerequisites:
|
|
84
84
|
|
|
85
|
-
- Install LearnChain and configure an LLM provider.
|
|
85
|
+
- Install LearnChain and configure an LLM provider. This can be an API-backed provider or a local CLI provider such as Codex CLI or Claude Code CLI.
|
|
86
86
|
- Run the command from a Codex session if you want LearnChain to resolve `CODEX_THREAD_ID` automatically.
|
|
87
87
|
|
|
88
88
|
Generate a deep dive for the active Codex session:
|
|
89
89
|
|
|
90
90
|
```bash
|
|
91
|
-
learnchain
|
|
91
|
+
learnchain deep-dive generate codex
|
|
92
92
|
```
|
|
93
93
|
|
|
94
94
|
Target a specific Codex session id explicitly:
|
|
95
95
|
|
|
96
96
|
```bash
|
|
97
|
-
learnchain
|
|
97
|
+
learnchain deep-dive generate codex --thread-id <thread-id>
|
|
98
98
|
```
|
|
99
99
|
|
|
100
|
-
The command writes the markdown artifact to `output/deep-dives/` and prints the saved path, title, goal, and accomplishment bullets to stdout for
|
|
100
|
+
The command writes the markdown artifact to `output/deep-dives/` and prints the saved path, title, goal, and accomplishment bullets to stdout for the active coding agent to relay back in chat. The command still resolves Codex sessions, but generation uses whichever provider is selected in LearnChain config, including `Claude Code CLI`.
|
|
101
101
|
|
|
102
102
|
To generate and immediately export the deep dive to the configured document repository:
|
|
103
103
|
|
|
104
104
|
```bash
|
|
105
|
-
learnchain
|
|
105
|
+
learnchain deep-dive generate codex --export
|
|
106
106
|
```
|
|
107
107
|
|
|
108
108
|
That uses the same repository settings as the Library export flow and prints the repository label plus remote URL when the export succeeds.
|
|
@@ -110,7 +110,7 @@ That uses the same repository settings as the Library export flow and prints the
|
|
|
110
110
|
To install the real Codex skill into your local Codex skills directory:
|
|
111
111
|
|
|
112
112
|
```bash
|
|
113
|
-
learnchain
|
|
113
|
+
learnchain skill install codex
|
|
114
114
|
```
|
|
115
115
|
|
|
116
116
|
This writes the bundled `learnchain-deep-dive` skill into `$CODEX_HOME/skills` when `CODEX_HOME` is set, or `~/.codex/skills` otherwise. Restart Codex after installation so it reloads available skills.
|
|
@@ -118,10 +118,10 @@ This writes the bundled `learnchain-deep-dive` skill into `$CODEX_HOME/skills` w
|
|
|
118
118
|
If you want the copy/paste custom-command template as well, print it with:
|
|
119
119
|
|
|
120
120
|
```bash
|
|
121
|
-
learnchain
|
|
121
|
+
learnchain action print codex
|
|
122
122
|
```
|
|
123
123
|
|
|
124
|
-
That template tells Codex to run LearnChain with `--
|
|
124
|
+
That template tells Codex to run LearnChain with `--thread-id "$CODEX_THREAD_ID"` and return the saved path plus a short summary.
|
|
125
125
|
|
|
126
126
|
## Usage
|
|
127
127
|
|
|
@@ -180,16 +180,16 @@ cargo run
|
|
|
180
180
|
cargo run -- --debug
|
|
181
181
|
|
|
182
182
|
# Generate a deep dive for the active Codex session
|
|
183
|
-
cargo run --
|
|
183
|
+
cargo run -- deep-dive generate codex
|
|
184
184
|
|
|
185
185
|
# Generate and export a deep dive for the active Codex session
|
|
186
|
-
cargo run --
|
|
186
|
+
cargo run -- deep-dive generate codex --export
|
|
187
187
|
|
|
188
188
|
# Install the bundled Codex skill
|
|
189
|
-
cargo run --
|
|
189
|
+
cargo run -- skill install codex
|
|
190
190
|
|
|
191
191
|
# Print the Codex custom command template
|
|
192
|
-
cargo run --
|
|
192
|
+
cargo run -- action print codex
|
|
193
193
|
|
|
194
194
|
# Run tests with output
|
|
195
195
|
cargo test -- --nocapture
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
package/package.json
CHANGED
package/scripts/install.js
CHANGED
|
@@ -58,6 +58,6 @@ if (platform !== 'win32') {
|
|
|
58
58
|
|
|
59
59
|
console.log(`✓ learnchain installed successfully for ${platform}-${arch}`);
|
|
60
60
|
console.log('\nRun: npx learnchain --help');
|
|
61
|
-
console.log('Tip: Run `npx learnchain
|
|
62
|
-
console.log('Codex tip: Run `npx learnchain
|
|
63
|
-
console.log('Codex tip: Run `npx learnchain
|
|
61
|
+
console.log('Tip: Run `npx learnchain config set openai-key <your-key>` to configure your OpenAI API key.');
|
|
62
|
+
console.log('Codex tip: Run `npx learnchain skill install codex` to install the LearnChain Codex skill.');
|
|
63
|
+
console.log('Codex tip: Run `npx learnchain action print codex` to print the Codex custom command template.');
|