Skip to content

Commit 9643f81

Browse files
authored
chore(release): v0.2.1 - redesigned docs and updated colors (#19)
* chore(release): bump version to v0.2.1 * docs: update documentation for v0.2.1 release * refactor(config): update colors and disable framework/runtime detection by default * assets: add promo image and GIF for v0.2.1 * ci(publish): add continue-on-error for GitHub Packages step
1 parent 5b41a01 commit 9643f81

File tree

8 files changed

+66
-176
lines changed

8 files changed

+66
-176
lines changed
1.55 MB
Loading
104 KB
Loading

.github/workflows/publish.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,8 +180,10 @@ jobs:
180180
scope: '@rmncldyo'
181181

182182
- name: Publish to GitHub Packages
183+
continue-on-error: true
183184
run: |
184-
# Package already has scoped name, publish directly
185+
# GitHub Packages requires scoped package name (@org/name)
186+
# Publishing unscoped package will fail but won't block the workflow
185187
npm publish --provenance --access public
186188
env:
187189
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [0.2.1] - 2025-10-28
9+
10+
### Changed
11+
12+
- Redesigned README for clarity and brevity - removed redundancy and streamlined documentation
13+
- Updated color palette to muted, cohesive scheme (steel blue, slate gray, soft coral, muted amber)
14+
- Updated color descriptions and code examples throughout
15+
- Disabled framework and runtime detection by default in `statusline-config.cjs` for cleaner default output
16+
- Added image with GIF fallback using HTML `<picture>` element for better media handling
17+
- Refined DIM color for improved visual hierarchy
18+
819
## [0.2.0] - 2025-10-28
920

1021
### Added
@@ -40,5 +51,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
4051
- Statusline scripts for project and Git status
4152
- TypeScript support with strict configuration
4253

54+
[0.2.1]: https://github.com/RMNCLDYO/create-claude-statusline/releases/tag/v0.2.1
4355
[0.2.0]: https://github.com/RMNCLDYO/create-claude-statusline/releases/tag/v0.2.0
4456
[0.1.0]: https://github.com/RMNCLDYO/create-claude-statusline/releases/tag/v0.1.0

README.md

Lines changed: 30 additions & 154 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
Beautiful, highly customizable status line for Claude Code with granular control over every element.
44

5-
[![version](https://img.shields.io/npm/v/create-claude-statusline.svg?label=version&color=brightgreen)](https://www.npmjs.com/package/create-claude-statusline)
6-
[![downloads](https://img.shields.io/npm/dm/create-claude-statusline.svg?label=downloads&color=blue)](https://www.npmjs.com/package/create-claude-statusline)
7-
[![package size](https://img.shields.io/npm/unpacked-size/create-claude-statusline?label=package%20size&color=yellow)](https://www.npmjs.com/package/create-claude-statusline)
8-
[![license](https://img.shields.io/badge/license-MIT-red.svg)](https://opensource.org/licenses/MIT)
5+
<picture>
6+
<source srcset=".github/assets/claude-code-statusline-promo.gif" type="image/gif">
7+
<img src=".github/assets/claude-code-statusline-promo.jpg" alt="Claude Code Statusline Promo">
8+
</picture>
99

1010
## Quick Start
1111

@@ -15,81 +15,35 @@ npm create claude-statusline
1515

1616
*Adds a beautiful status line to your Claude Code. ZERO dependencies in your project.*
1717

18-
### ✨ What's New
19-
20-
- **Granular Control**: Toggle every element individually - project, branch, framework, runtime, each git status type, and model
21-
- **Centralized Config**: New `statusline-config.cjs` file for easy customization
22-
- **Intuitive Colors**: Color-coded git status (green → orange → yellow → red) for instant visual feedback
23-
- **Performance**: Only runs git operations when needed based on your config
24-
2518
## What You Get
2619

2720
```
2821
[ ◈ my-project on ⎇ main via ◉ React (node) | ↑ 2 / + 1 / ~ 3 / ? 2 | ⌘ Sonnet 4.5 ]
2922
```
3023

31-
**What each element shows:**
32-
- `◈ my-project` - Project name (light blue)
33-
- `⎇ main` - Git branch (light green)
34-
- `◉ React (node)` - Framework and runtime (pink/tan)
35-
- `↑ 2` - Commits ahead (green)
36-
- `+ 1` - Staged files (orange)
37-
- `~ 3` - Modified files (yellow)
38-
- `? 2` - Untracked files (red)
39-
- `⌘ Sonnet 4.5` - Claude model (purple)
40-
41-
**Color coding:** Green (good) → Orange (ready) → Yellow (pending) → Red (needs attention)
24+
- Project name, git branch, framework, and runtime
25+
- Commit status (ahead/behind)
26+
- Git status indicators (staged, modified, untracked)
27+
- Current Claude model
28+
- Fully customizable: toggle any element, change colors, swap icons
4229

4330
## Installation
4431

4532
```bash
46-
npm create claude-statusline # npm
47-
npx create-claude-statusline # npx
48-
pnpm dlx create-claude-statusline # pnpm
49-
bunx create-claude-statusline # bun
33+
npm create claude-statusline
5034
```
5135

52-
### Options
53-
36+
Or with other package managers:
5437
```bash
55-
npm create claude-statusline --dry-run # Preview what will be installed
56-
npm create claude-statusline --help # Show all options
38+
npx create-claude-statusline # npx
39+
pnpm dlx create-claude-statusline # pnpm
40+
bunx create-claude-statusline # bun
5741
```
5842

59-
### Global Install
60-
43+
Global install:
6144
```bash
6245
npm install -g create-claude-statusline
63-
create-claude-statusline # Run from anywhere
64-
ccs # Short alias
65-
```
66-
67-
## Features
68-
69-
🎯 **Granular Control** - Toggle every element individually (project name, branch, framework, runtime, each git status type, model)
70-
71-
📊 **Clear Git Status** - Separate indicators for ahead/behind, staged, modified, and untracked with intuitive color coding (green → orange → yellow → red)
72-
73-
**Smart Detection** - Automatically detects your framework (React, Vue, Next.js, etc.) and runtime (Node, Bun, Python, Rust, Go, etc.)
74-
75-
🎨 **Fully Customizable** - Centralized config file for all features, colors, and icons
76-
77-
**Fast & Efficient** - Intelligent caching with rate limiting for sub-100ms updates
78-
79-
🔒 **Safe & Secure** - Command allowlisting, path validation, and automatic backups
80-
81-
📦 **Zero Dependencies** - No runtime dependencies in your project
82-
83-
## What Gets Installed
84-
85-
```
86-
.claude/
87-
├── settings.local.json # Status line configuration
88-
└── scripts/
89-
├── statusline.cjs # Main status line logic
90-
├── statusline-config.cjs # Configuration options
91-
├── statusline-git.cjs # Git integration
92-
└── statusline-detect.cjs # Framework detection
46+
create-claude-statusline # or use alias: ccs
9347
```
9448

9549
## Customization
@@ -118,16 +72,16 @@ Color scheme follows an intuitive severity gradient:
11872

11973
```javascript
12074
COLORS: {
121-
PROJECT: '\x1b[38;5;117m', // Light blue
122-
BRANCH: '\x1b[38;5;156m', // Light green
123-
FRAMEWORK: '\x1b[38;5;219m', // Pink
124-
RUNTIME: '\x1b[38;5;180m', // Tan
125-
GIT_AHEAD: '\x1b[38;5;46m', // Green - you're ahead!
126-
GIT_BEHIND: '\x1b[38;5;196m', // Red - action needed
127-
GIT_STAGED: '\x1b[38;5;214m', // Orange - ready to commit
128-
GIT_MODIFIED: '\x1b[38;5;226m', // Yellow - needs staging
129-
GIT_UNTRACKED: '\x1b[38;5;196m', // Red - needs attention
130-
MODEL: '\x1b[38;5;93m', // Purple
75+
PROJECT: '\x1b[38;5;110m', // Muted steel blue
76+
BRANCH: '\x1b[38;5;109m', // Slate gray-blue
77+
FRAMEWORK: '\x1b[38;5;145m', // Cool gray
78+
RUNTIME: '\x1b[38;5;180m', // Muted beige
79+
GIT_AHEAD: '\x1b[38;5;109m', // Slate blue
80+
GIT_BEHIND: '\x1b[38;5;167m', // Soft coral
81+
GIT_STAGED: '\x1b[38;5;108m', // Muted teal-green
82+
GIT_MODIFIED: '\x1b[38;5;180m', // Muted amber
83+
GIT_UNTRACKED: '\x1b[38;5;167m', // Soft coral
84+
MODEL: '\x1b[38;5;146m', // Soft gray-green
13185
}
13286
```
13387

@@ -147,102 +101,24 @@ ICONS: {
147101

148102
### Supported Frameworks & Runtimes
149103

150-
**Frameworks:** Next.js, Nuxt.js, NestJS, React, Vue, Angular, Svelte, Express, Fastify
104+
**Frameworks:** `Next.js`, `Nuxt.js`, `NestJS`, `React`, `Vue`, `Angular`, `Svelte`, `Express`, `Fastify`
151105

152-
**Runtimes:** Node.js, Bun, TypeScript, Python, Rust, Go, Java, C/C++
106+
**Runtimes:** `Node.js`, `Bun`, `TypeScript`, `Python`, `Rust`, `Go`, `Java`, `C/C++`
153107

154108
All configuration is centralized in `.claude/scripts/statusline-config.cjs` - one file to control everything!
155109

156110
## Safety
157111

158-
If you already have a `.claude` directory, it will be backed up to `.create-claude-statusline-backup-[timestamp]` before installation.
159-
160-
### Restore from Backup
161-
```bash
162-
# List backups
163-
ls -la .create-claude-statusline-backup-*
164-
165-
# Restore
166-
rm -rf .claude
167-
mv .create-claude-statusline-backup-[timestamp] .claude
168-
```
112+
Your existing `.claude` directory is automatically backed up to `.create-claude-statusline-backup-[timestamp]` before installation.
169113

170114
## Uninstall
171115

172116
```bash
173-
# Remove status line configuration
174117
rm -rf .claude/scripts/statusline*.cjs
175-
176-
# Edit .claude/settings.local.json and remove the "statusLine" section
177-
```
178-
179-
## Programmatic Usage
180-
181-
```javascript
182-
import { init } from 'create-claude-statusline';
183-
184-
await init('/path/to/project', {
185-
dryRun: false // Set to true for preview
186-
});
187-
```
188-
189-
## Requirements
190-
191-
- Node.js 18+
192-
- [Claude Code](https://claude.ai/code)
193-
- Git (optional, for git status features)
194-
195-
## Example: Minimal Configuration
196-
197-
Want just git branch and status? Edit `.claude/scripts/statusline-config.cjs`:
198-
199-
```javascript
200-
FEATURES: {
201-
SHOW_PROJECT: false, // Hide project name
202-
SHOW_GIT_BRANCH: true, // Show branch
203-
SHOW_FRAMEWORK: false, // Hide framework
204-
SHOW_RUNTIME: false, // Hide runtime
205-
SHOW_GIT_AHEAD: true, // Show ahead
206-
SHOW_GIT_BEHIND: true, // Show behind
207-
SHOW_GIT_STAGED: true, // Show staged
208-
SHOW_GIT_MODIFIED: true, // Show modified
209-
SHOW_GIT_UNTRACKED: true, // Show untracked
210-
SHOW_MODEL: false, // Hide model
211-
}
212-
```
213-
214-
Result: `[ ⎇ main | ↑ 1 / + 2 / ~ 3 / ? 1 ]`
215-
216-
## Troubleshooting
217-
218-
**Status line not showing?**
219-
```bash
220-
# Check installation
221-
ls -la .claude/scripts/statusline.cjs
222-
223-
# Test manually
224-
echo '{"model":{"display_name":"Test"},"workspace":{"current_dir":"'"$(pwd)"'"}}' | node .claude/scripts/statusline.cjs
225118
```
226119

227-
**Git info missing?**
228-
- Ensure you're in a git repository (`git status` should work)
229-
- Check that git features are enabled in `statusline-config.cjs`
230-
231-
**Want different colors?**
232-
- Edit COLORS in `.claude/scripts/statusline-config.cjs`
233-
- Use 256-color codes: `\x1b[38;5;NUMBERm` (see [256-color chart](https://upload.wikimedia.org/wikipedia/commons/1/15/Xterm_256color_chart.svg))
234-
235-
## Links
236-
237-
[**Issues**](https://github.com/RMNCLDYO/create-claude-statusline/issues)
238-
[**Discussions**](https://github.com/RMNCLDYO/create-claude-statusline/discussions)
239-
[**Changelog**](CHANGELOG.md)
240-
[**Security**](SECURITY.md)
120+
Then remove the `"statusLine"` section from `.claude/settings.local.json`.
241121

242122
## License
243123

244124
MIT © [RMNCLDYO](https://github.com/RMNCLDYO)
245-
246-
---
247-
248-
Originally extracted from [create-claude](https://github.com/RMNCLDYO/create-claude) due to popular demand for the standalone status line feature.

package-lock.json

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "create-claude-statusline",
3-
"version": "0.2.0",
3+
"version": "0.2.1",
44
"description": "Beautiful, highly customizable status line for Claude Code with granular control over every element. Shows project info, git status, framework, and model.",
55
"type": "module",
66
"sideEffects": false,
@@ -96,7 +96,7 @@
9696
"preferGlobal": false,
9797
"stability": "stable",
9898
"devDependencies": {
99-
"@types/node": "^24.9.1",
99+
"@types/node": "^24.9.2",
100100
"typescript": "^5.9.3"
101101
}
102102
}

skel/.claude/scripts/statusline-config.cjs

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ module.exports = {
44
FEATURES: {
55
SHOW_PROJECT: true,
66
SHOW_GIT_BRANCH: true,
7-
SHOW_FRAMEWORK: true,
8-
SHOW_RUNTIME: true,
7+
SHOW_FRAMEWORK: false,
8+
SHOW_RUNTIME: false,
99
SHOW_GIT_AHEAD: true,
1010
SHOW_GIT_BEHIND: true,
1111
SHOW_GIT_STAGED: true,
@@ -15,17 +15,17 @@ module.exports = {
1515
},
1616

1717
COLORS: {
18-
PROJECT: '\x1b[38;5;117m',
19-
BRANCH: '\x1b[38;5;156m',
20-
FRAMEWORK: '\x1b[38;5;219m',
21-
RUNTIME: '\x1b[38;5;180m',
22-
GIT_AHEAD: '\x1b[38;5;46m',
23-
GIT_BEHIND: '\x1b[38;5;196m',
24-
GIT_STAGED: '\x1b[38;5;214m',
25-
GIT_MODIFIED: '\x1b[38;5;226m',
26-
GIT_UNTRACKED: '\x1b[38;5;196m',
27-
MODEL: '\x1b[38;5;93m',
28-
DIM: '\x1b[38;5;244m',
18+
PROJECT: '\x1b[38;5;110m', // Muted steel blue
19+
BRANCH: '\x1b[38;5;109m', // Slate gray-blue
20+
FRAMEWORK: '\x1b[38;5;145m', // Cool gray
21+
RUNTIME: '\x1b[38;5;180m', // Muted beige
22+
GIT_AHEAD: '\x1b[38;5;109m', // Slate blue
23+
GIT_BEHIND: '\x1b[38;5;167m', // Soft coral
24+
GIT_STAGED: '\x1b[38;5;108m', // Muted teal-green
25+
GIT_MODIFIED: '\x1b[38;5;180m', // Muted amber
26+
GIT_UNTRACKED: '\x1b[38;5;167m', // Soft coral
27+
MODEL: '\x1b[38;5;146m', // Soft gray-green
28+
DIM: '\x1b[38;5;243m', // Subtle gray
2929
RESET: '\x1b[0m'
3030
},
3131

0 commit comments

Comments
 (0)