learnchain 0.1.0 → 0.2.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
CHANGED
|
@@ -4,6 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
**LearnChain** is a terminal-based learning tool that helps you learn to code while using generative AI to build projects. It analyzes your Codex or Claude session logs and surfaces interactive quizzes in a beautiful terminal UI, reinforcing concepts as you work.
|
|
6
6
|
|
|
7
|
+
|
|
8
|
+
|
|
7
9
|
## Features
|
|
8
10
|
|
|
9
11
|
- **Session Log Analysis**: Parse and learn from your AI-assisted coding sessions
|
|
@@ -12,47 +14,40 @@
|
|
|
12
14
|
- **Multi-platform Support**: Distributed via npm for easy installation across platforms
|
|
13
15
|
- **Interactive TUI**: Built with [Ratatui](https://ratatui.rs) for a polished terminal experience
|
|
14
16
|
|
|
15
|
-
##
|
|
16
|
-
|
|
17
|
-
### Via npm (Recommended)
|
|
18
|
-
|
|
17
|
+
## Quick Start
|
|
19
18
|
```bash
|
|
20
19
|
npm install -g learnchain
|
|
21
|
-
npx learnchain --help
|
|
22
20
|
```
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
21
|
+
#### Two options to set API Key:
|
|
22
|
+
Option 1:
|
|
23
|
+
Start learnchain with
|
|
26
24
|
```bash
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
25
|
+
learnchain
|
|
26
|
+
```
|
|
27
|
+
Then,
|
|
28
|
+
```bash
|
|
29
|
+
"Configure details" -> "OpenAI API key:" -> (set your api key here) -> Enter -> m (menu)
|
|
31
30
|
```
|
|
32
31
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
npx learnchain --set-openai-key sk-...
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
Or configure it directly in the TUI: Config view → "OpenAI API key" → press Enter to edit
|
|
32
|
+
Option 2:
|
|
33
|
+
```bash
|
|
34
|
+
learnchain --set-openai-key <key>
|
|
35
|
+
```
|
|
41
36
|
|
|
42
|
-
|
|
43
|
-
```bash
|
|
44
|
-
cargo run
|
|
45
|
-
# or if installed via npm:
|
|
46
|
-
npx learnchain
|
|
47
|
-
```
|
|
37
|
+
## Installation From Source
|
|
48
38
|
|
|
49
|
-
|
|
39
|
+
```bash
|
|
40
|
+
git clone https://github.com/normand1/learnchain
|
|
41
|
+
cd learnchain
|
|
42
|
+
cargo build
|
|
43
|
+
cargo run
|
|
44
|
+
```
|
|
50
45
|
|
|
51
46
|
## Development
|
|
52
47
|
|
|
53
48
|
### Prerequisites
|
|
54
49
|
|
|
55
|
-
- Rust
|
|
50
|
+
- Rust
|
|
56
51
|
- Node.js >= 16 (for npm distribution)
|
|
57
52
|
- Cargo
|
|
58
53
|
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
package/package.json
CHANGED