aiblueprint-cli 1.0.0 → 1.0.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 +34 -81
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,108 +2,46 @@
|
|
|
2
2
|
|
|
3
3
|
A CLI tool for setting up Claude Code configurations with AIBlueprint defaults.
|
|
4
4
|
|
|
5
|
-
##
|
|
6
|
-
|
|
7
|
-
### Setup
|
|
5
|
+
## Quick Start
|
|
8
6
|
|
|
9
7
|
```bash
|
|
10
|
-
#
|
|
11
|
-
|
|
8
|
+
# Run immediately without installation
|
|
9
|
+
bunx aiblueprint-cli claude-code setup
|
|
12
10
|
```
|
|
13
11
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
```bash
|
|
17
|
-
# Build the CLI
|
|
18
|
-
bun run build
|
|
19
|
-
|
|
20
|
-
# Test locally with npm link
|
|
21
|
-
npm link
|
|
22
|
-
|
|
23
|
-
# Test the CLI
|
|
24
|
-
aiblueprint claude-code setup
|
|
25
|
-
|
|
26
|
-
# Or test directly with node
|
|
27
|
-
node dist/cli.js claude-code setup
|
|
28
|
-
|
|
29
|
-
# Test with custom folder (for development)
|
|
30
|
-
mkdir ./test-claude-config
|
|
31
|
-
node dist/cli.js claude-code -f ./test-claude-config setup
|
|
32
|
-
|
|
33
|
-
# Run in development mode
|
|
34
|
-
bun run dev claude-code setup
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
### Publishing
|
|
38
|
-
|
|
39
|
-
#### Automated Release (Recommended)
|
|
40
|
-
|
|
41
|
-
```bash
|
|
42
|
-
# This will automatically:
|
|
43
|
-
# 1. Increment version
|
|
44
|
-
# 2. Build the project
|
|
45
|
-
# 3. Create git tag
|
|
46
|
-
# 4. Publish to npm
|
|
47
|
-
bun run release
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
#### Manual Release
|
|
51
|
-
|
|
52
|
-
```bash
|
|
53
|
-
# Build first
|
|
54
|
-
bun run build
|
|
55
|
-
|
|
56
|
-
# Then publish
|
|
57
|
-
npm publish
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
### Scripts
|
|
61
|
-
|
|
62
|
-
- `bun run build` - Build the TypeScript to JavaScript
|
|
63
|
-
- `bun run dev` - Run in development mode
|
|
64
|
-
- `bun run release` - Automated release with version bump and publish
|
|
65
|
-
- `bun run test-local` - Test locally with npm link
|
|
66
|
-
|
|
67
|
-
## Usage
|
|
68
|
-
|
|
69
|
-
### Installation
|
|
12
|
+
## Installation & Usage
|
|
70
13
|
|
|
71
14
|
```bash
|
|
72
15
|
# Install globally
|
|
73
|
-
npm install -g
|
|
16
|
+
npm install -g aiblueprint-cli
|
|
74
17
|
|
|
75
|
-
# Or use with npx/pnpm dlx
|
|
76
|
-
npx
|
|
77
|
-
pnpm dlx
|
|
18
|
+
# Or use with npx/pnpm dlx/bunx
|
|
19
|
+
npx aiblueprint-cli claude-code setup
|
|
20
|
+
pnpm dlx aiblueprint-cli claude-code setup
|
|
21
|
+
bunx aiblueprint-cli claude-code setup
|
|
78
22
|
```
|
|
79
23
|
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
```bash
|
|
83
|
-
aiblueprint claude-code setup
|
|
84
|
-
```
|
|
24
|
+
## What it does
|
|
85
25
|
|
|
86
|
-
|
|
26
|
+
The setup command will interactively configure your Claude Code environment with:
|
|
87
27
|
|
|
88
28
|
- **Shell shortcuts** - Add `cc` and `ccc` aliases for quick access
|
|
89
|
-
- **Command validation** - Security hook for bash commands
|
|
29
|
+
- **Command validation** - Security hook for bash commands
|
|
90
30
|
- **Custom statusline** - Shows git, costs, tokens info
|
|
91
31
|
- **AIBlueprint commands** - Pre-configured command templates
|
|
92
32
|
- **AIBlueprint agents** - Specialized AI agents
|
|
93
33
|
- **Output styles** - Custom output formatting
|
|
94
34
|
- **Notification sounds** - Audio alerts for events
|
|
95
35
|
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
The setup command will:
|
|
36
|
+
### Setup Process
|
|
99
37
|
|
|
100
|
-
1.
|
|
101
|
-
2.
|
|
102
|
-
3.
|
|
103
|
-
4.
|
|
104
|
-
5.
|
|
38
|
+
1. Creates `~/.claude/` directory if it doesn't exist
|
|
39
|
+
2. Copies selected configurations to your `.claude` folder
|
|
40
|
+
3. Updates your `~/.claude/settings.json` with new configurations
|
|
41
|
+
4. Installs required dependencies (`bun`, `ccusage`)
|
|
42
|
+
5. Adds shell aliases to your shell configuration file
|
|
105
43
|
|
|
106
|
-
|
|
44
|
+
### Shell Shortcuts
|
|
107
45
|
|
|
108
46
|
After setup, you can use:
|
|
109
47
|
- `cc` - Claude Code with permissions skipped
|
|
@@ -115,6 +53,21 @@ After setup, you can use:
|
|
|
115
53
|
- macOS or Linux
|
|
116
54
|
- Claude Code installed
|
|
117
55
|
|
|
56
|
+
## Development
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
# Install dependencies
|
|
60
|
+
bun install
|
|
61
|
+
|
|
62
|
+
# Build and test locally
|
|
63
|
+
bun run build
|
|
64
|
+
npm link
|
|
65
|
+
aiblueprint claude-code setup
|
|
66
|
+
|
|
67
|
+
# Development mode
|
|
68
|
+
bun run dev claude-code setup
|
|
69
|
+
```
|
|
70
|
+
|
|
118
71
|
## License
|
|
119
72
|
|
|
120
73
|
MIT
|