@sunasteriskrnd/takumi 0.1.0 → 1.0.0-dev.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
@@ -4,7 +4,7 @@ Command-line tool for bootstrapping and managing [Takumi](https://github.com/sun
4
4
 
5
5
  ## Overview
6
6
 
7
- `takumi` 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.
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,28 @@ 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: `takumi --version`
28
+ Verify: `tkm --version`
29
29
 
30
30
  ## Usage
31
31
 
32
32
  ### Quick Start
33
33
 
34
34
  ```bash
35
- takumi --help # All commands
36
- takumi new # Create new project (interactive)
37
- takumi new --kit engineer # Create with specific kit
38
- takumi init # Initialize/update in current project
39
- takumi init -g -y # Global install, non-interactive
35
+ tkm --help # All commands
36
+ tkm new # Create new project (interactive)
37
+ tkm new --kit engineer # Create with specific kit
38
+ tkm init # Initialize/update in current project
39
+ tkm init -g -y # Global install, non-interactive
40
40
  ```
41
41
 
42
42
  ### Create New Project
43
43
 
44
44
  ```bash
45
- takumi new # Interactive
46
- takumi new --dir my-project --kit engineer # With options
47
- takumi new --archive ~/kit.zip # Offline install
48
- takumi new --install-skills # Auto-install skill deps
49
- takumi new --prefix # /takumi: namespace for commands
45
+ tkm new # Interactive
46
+ tkm new --dir my-project --kit engineer # With options
47
+ tkm new --archive ~/kit.zip # Offline install
48
+ tkm new --install-skills # Auto-install skill deps
49
+ tkm new --prefix # /tkm: namespace for commands
50
50
  ```
51
51
 
52
52
  ### Initialize or Update
@@ -54,79 +54,72 @@ takumi new --prefix # /takumi: namespace for commands
54
54
  Run from project root:
55
55
 
56
56
  ```bash
57
- takumi init # Interactive
58
- takumi init -y # Non-interactive, latest version
59
- takumi init -g --kit engineer -y # Global install
60
- takumi init --fresh # Clean reinstall (destructive)
61
- takumi init --archive ~/kit.zip # Offline install
62
- takumi init --local # From local monorepo (development)
57
+ tkm init # Interactive
58
+ tkm init -y # Non-interactive, latest version
59
+ tkm init -g --kit engineer -y # Global install
60
+ tkm init --fresh # Clean reinstall (destructive)
61
+ tkm init --archive ~/kit.zip # Offline install
62
+ tkm init --local # From local monorepo (development)
63
63
  ```
64
64
 
65
65
  ### Update CLI
66
66
 
67
67
  ```bash
68
- takumi update # Update to latest
69
- takumi update --check # Check only
70
- takumi update --version 1.1.3 # Specific version
68
+ tkm update # Update to latest
69
+ tkm update --check # Check only
70
+ tkm update --version 1.1.3 # Specific version
71
71
  ```
72
72
 
73
73
  ### Diagnostics
74
74
 
75
75
  ```bash
76
- takumi doctor # Full health check
77
- takumi doctor --fix # Auto-fix issues
78
- takumi doctor --report # Shareable diagnostic report
76
+ tkm doctor # Full health check
77
+ tkm doctor --fix # Auto-fix issues
78
+ tkm doctor --report # Shareable diagnostic report
79
79
  ```
80
80
 
81
81
  ### Skills & Agents
82
82
 
83
83
  ```bash
84
- takumi skills --help # Skill management
85
- takumi agents --help # Agent management
86
- takumi commands --help # Command discovery
84
+ tkm skills --help # Skill management
85
+ tkm agents --help # Agent management
86
+ tkm commands --help # Command discovery
87
87
  ```
88
88
 
89
89
  ### Other Commands
90
90
 
91
91
  ```bash
92
- takumi versions # List available versions
93
- takumi migrate # Run migration pipeline
94
- takumi uninstall # Remove Takumi
95
- takumi config get defaults.kit # Read config
96
- takumi config set defaults.kit engineer # Write config
92
+ tkm versions # List available versions
93
+ tkm migrate # Run migration pipeline
94
+ tkm uninstall # Remove Takumi
95
+ tkm config get defaults.kit # Read config
96
+ tkm config set defaults.kit engineer # Write config
97
97
  ```
98
98
 
99
99
  ### Debugging
100
100
 
101
101
  ```bash
102
- takumi new --verbose # Verbose logging
103
- takumi new --verbose --log-file debug.log # Save to file
104
- SUN_AGENT_KIT_VERBOSE=1 takumi new # Via env var
102
+ tkm new --verbose # Verbose logging
103
+ tkm new --verbose --log-file debug.log # Save to file
104
+ TAKUMI_VERBOSE=1 tkm new # Via env var
105
105
  ```
106
106
 
107
107
  ## Authentication
108
108
 
109
109
  ```
110
- 1. GitHub CLI (gh auth token)
110
+ 1. Environment Variables (GITHUB_TOKEN, GH_TOKEN)
111
111
  ↓ fallback
112
- 2. Environment Variables (GITHUB_TOKEN)
113
- ↓ fallback
114
- 3. Config File (~/.sun-takumi/config.json)
115
- ↓ fallback
116
- 4. OS Keychain
117
- ↓ fallback
118
- 5. User Prompt (with save option)
112
+ 2. GitHub CLI (gh auth token)
119
113
  ```
120
114
 
121
- **Recommended:** `gh auth login` with web browser OAuth.
115
+ **Recommended:** `gh auth login` then authenticate via web browser OAuth.
122
116
 
123
117
  ## Configuration
124
118
 
125
- Stored in `~/.sun-takumi/config.json`:
119
+ Global config stored in `~/.claude/.takumi.json`; project config at `<project>/.claude/.takumi.json`.
126
120
 
127
121
  ```json
128
122
  {
129
- "github": { "token": "stored_in_keychain" },
130
123
  "defaults": { "kit": "engineer", "dir": "." }
131
124
  }
132
125
  ```
@@ -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/agent-kit-cli/issues");
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
  };