@sunasteriskrnd/takumi 0.1.0 → 0.3.0
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 +45 -46
- package/bin/{takumi.js → tkm.js} +1 -1
- package/dist/index.js +15820 -2730
- package/package.json +8 -6
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@ Command-line tool for bootstrapping and managing [Takumi](https://github.com/sun
|
|
|
4
4
|
|
|
5
5
|
## Overview
|
|
6
6
|
|
|
7
|
-
`
|
|
7
|
+
`tkm` manages Takumi installations — install, update, migrate, and configure kits from GitHub releases. Built with Bun + TypeScript for development; published CLI runs on plain Node.js.
|
|
8
8
|
|
|
9
9
|
**Key features:**
|
|
10
10
|
- Install/update kits from GitHub releases or local archives
|
|
@@ -25,28 +25,34 @@ Command-line tool for bootstrapping and managing [Takumi](https://github.com/sun
|
|
|
25
25
|
npm install -g @sunasteriskrnd/takumi
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
Verify: `
|
|
28
|
+
Verify: `tkm --version`
|
|
29
29
|
|
|
30
30
|
## Usage
|
|
31
31
|
|
|
32
32
|
### Quick Start
|
|
33
33
|
|
|
34
34
|
```bash
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
35
|
+
tkm --help # All commands
|
|
36
|
+
tkm auth login # One-time login (default install path)
|
|
37
|
+
tkm new # Create new project (interactive)
|
|
38
|
+
tkm new --kit engineer # Create with specific kit
|
|
39
|
+
tkm init # Initialize/update in current project
|
|
40
|
+
tkm init -g -y # Global install, non-interactive
|
|
40
41
|
```
|
|
41
42
|
|
|
43
|
+
The default `tkm init` / `new` / `versions` flows download releases
|
|
44
|
+
through the authenticated Takumi server (no `gh` CLI required). Run
|
|
45
|
+
`tkm auth login` once before the first install. The legacy GitHub
|
|
46
|
+
flow is still available via `--use-gh` for archived tags.
|
|
47
|
+
|
|
42
48
|
### Create New Project
|
|
43
49
|
|
|
44
50
|
```bash
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
51
|
+
tkm new # Interactive
|
|
52
|
+
tkm new --dir my-project --kit engineer # With options
|
|
53
|
+
tkm new --archive ~/kit.zip # Offline install
|
|
54
|
+
tkm new --install-skills # Auto-install skill deps
|
|
55
|
+
tkm new --prefix # /tkm: namespace for commands
|
|
50
56
|
```
|
|
51
57
|
|
|
52
58
|
### Initialize or Update
|
|
@@ -54,79 +60,72 @@ takumi new --prefix # /takumi: namespace for commands
|
|
|
54
60
|
Run from project root:
|
|
55
61
|
|
|
56
62
|
```bash
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
+
tkm init # Interactive
|
|
64
|
+
tkm init -y # Non-interactive, latest version
|
|
65
|
+
tkm init -g --kit engineer -y # Global install
|
|
66
|
+
tkm init --fresh # Clean reinstall (destructive)
|
|
67
|
+
tkm init --archive ~/kit.zip # Offline install
|
|
68
|
+
tkm init --local # From local monorepo (development)
|
|
63
69
|
```
|
|
64
70
|
|
|
65
71
|
### Update CLI
|
|
66
72
|
|
|
67
73
|
```bash
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
74
|
+
tkm update # Update to latest
|
|
75
|
+
tkm update --check # Check only
|
|
76
|
+
tkm update --version 1.1.3 # Specific version
|
|
71
77
|
```
|
|
72
78
|
|
|
73
79
|
### Diagnostics
|
|
74
80
|
|
|
75
81
|
```bash
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
82
|
+
tkm doctor # Full health check
|
|
83
|
+
tkm doctor --fix # Auto-fix issues
|
|
84
|
+
tkm doctor --report # Shareable diagnostic report
|
|
79
85
|
```
|
|
80
86
|
|
|
81
87
|
### Skills & Agents
|
|
82
88
|
|
|
83
89
|
```bash
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
90
|
+
tkm skills --help # Skill management
|
|
91
|
+
tkm agents --help # Agent management
|
|
92
|
+
tkm commands --help # Command discovery
|
|
87
93
|
```
|
|
88
94
|
|
|
89
95
|
### Other Commands
|
|
90
96
|
|
|
91
97
|
```bash
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
98
|
+
tkm versions # List available versions
|
|
99
|
+
tkm migrate # Run migration pipeline
|
|
100
|
+
tkm uninstall # Remove Takumi
|
|
101
|
+
tkm config get defaults.kit # Read config
|
|
102
|
+
tkm config set defaults.kit engineer # Write config
|
|
97
103
|
```
|
|
98
104
|
|
|
99
105
|
### Debugging
|
|
100
106
|
|
|
101
107
|
```bash
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
108
|
+
tkm new --verbose # Verbose logging
|
|
109
|
+
tkm new --verbose --log-file debug.log # Save to file
|
|
110
|
+
TAKUMI_VERBOSE=1 tkm new # Via env var
|
|
105
111
|
```
|
|
106
112
|
|
|
107
113
|
## Authentication
|
|
108
114
|
|
|
109
115
|
```
|
|
110
|
-
1.
|
|
111
|
-
↓ fallback
|
|
112
|
-
2. Environment Variables (GITHUB_TOKEN)
|
|
113
|
-
↓ fallback
|
|
114
|
-
3. Config File (~/.sun-takumi/config.json)
|
|
115
|
-
↓ fallback
|
|
116
|
-
4. OS Keychain
|
|
116
|
+
1. Environment Variables (GITHUB_TOKEN, GH_TOKEN)
|
|
117
117
|
↓ fallback
|
|
118
|
-
|
|
118
|
+
2. GitHub CLI (gh auth token)
|
|
119
119
|
```
|
|
120
120
|
|
|
121
|
-
**Recommended:** `gh auth login`
|
|
121
|
+
**Recommended:** `gh auth login` then authenticate via web browser OAuth.
|
|
122
122
|
|
|
123
123
|
## Configuration
|
|
124
124
|
|
|
125
|
-
|
|
125
|
+
Global config stored in `~/.claude/.takumi.json`; project config at `<project>/.claude/.takumi.json`.
|
|
126
126
|
|
|
127
127
|
```json
|
|
128
128
|
{
|
|
129
|
-
"github": { "token": "stored_in_keychain" },
|
|
130
129
|
"defaults": { "kit": "engineer", "dir": "." }
|
|
131
130
|
}
|
|
132
131
|
```
|
package/bin/{takumi.js → tkm.js}
RENAMED
|
@@ -48,7 +48,7 @@ const main = async () => {
|
|
|
48
48
|
await runWithNode();
|
|
49
49
|
} catch (err) {
|
|
50
50
|
console.error(`[X] Failed to run CLI: ${getErrorMessage(err)}`);
|
|
51
|
-
console.error("Please report this issue at: https://github.com/sun-asterisk-internal/
|
|
51
|
+
console.error("Please report this issue at: https://github.com/sun-asterisk-internal/takumi-cli/issues");
|
|
52
52
|
process.exit(1);
|
|
53
53
|
}
|
|
54
54
|
};
|