docs: update npm package name from @kai/ccs to @kaitranntt/ccs

This commit is contained in:
kaitranntt
2025-11-04 23:25:36 -05:00
parent 007996d31a
commit 1a5ae615e3
5 changed files with 24 additions and 24 deletions
+3 -3
View File
@@ -88,10 +88,10 @@ Format based on [Keep a Changelog](https://keepachangelog.com/).
- **Installation**: npm package now supports cross-platform distribution
### Added
- **npm Package Support**: `npm install -g @kai/ccs` for easy cross-platform installation
- **npm Package Support**: `npm install -g @kaitranntt/ccs` for easy cross-platform installation
- **Cross-Platform Entry Point**: `bin/ccs.js` Node.js wrapper with platform detection
- **Version Management**: `scripts/sync-version.js` and `scripts/check-executables.js` for consistency
- **Package Metadata**: Complete package.json with bin field and scoped package name (@kai/ccs)
- **Package Metadata**: Complete package.json with bin field and scoped package name (@kaitranntt/ccs)
### Changed
- **Directory Structure**: `ccs` and `ccs.ps1` moved to `lib/` directory
@@ -113,7 +113,7 @@ Format based on [Keep a Changelog](https://keepachangelog.com/).
- **Breaking Changes**: Only affects package structure, CLI functionality unchanged
### Installation Methods (All Working)
- **npm (Recommended)**: `npm install -g @kai/ccs`
- **npm (Recommended)**: `npm install -g @kaitranntt/ccs`
- **Traditional Unix**: `curl -fsSL ccs.kaitran.ca/install | bash`
- **Traditional Windows**: `irm ccs.kaitran.ca/install | iex`
- **Git Development**: `./installers/install.sh`
+2 -2
View File
@@ -7,7 +7,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
CCS (Claude Code Switch) is a lightweight CLI wrapper enabling instant profile switching between Claude Sonnet 4.5 and GLM 4.6 models. The tool delegates to the official Claude CLI via the `--settings` flag, supporting both Unix-like systems (bash) and Windows (PowerShell).
**Primary Installation Methods** (highest priority):
- **npm Package** (recommended): `npm install -g @kai/ccs` (cross-platform)
- **npm Package** (recommended): `npm install -g @kaitranntt/ccs` (cross-platform)
- macOS/Linux: `curl -fsSL ccs.kaitran.ca/install | bash`
- Windows: `irm ccs.kaitran.ca/install | iex`
@@ -127,7 +127,7 @@ cat VERSION
npm pack # Creates kai-ccs-X.Y.Z.tgz
npm install -g kai-ccs-X.Y.Z.tgz # Test installation
ccs --version # Verify it works
npm uninstall -g @kai/ccs # Cleanup
npm uninstall -g @kaitranntt/ccs # Cleanup
rm kai-ccs-X.Y.Z.tgz # Remove tarball
# Clean test environment
+6 -6
View File
@@ -11,7 +11,7 @@ Switch between Claude Sonnet 4.5 and GLM 4.6 instantly. Stop hitting rate limits
[![License](https://img.shields.io/badge/license-MIT-C15F3C?style=for-the-badge)](LICENSE)
[![Platform](https://img.shields.io/badge/platform-macOS%20%7C%20Linux%20%7C%20Windows-lightgrey?style=for-the-badge)]()
[![npm](https://img.shields.io/npm/v/@kai/ccs?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@kai/ccs)
[![npm](https://img.shields.io/npm/v/@kaitranntt/ccs?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@kaitranntt/ccs)
[![PoweredBy](https://img.shields.io/badge/PoweredBy-ClaudeKit-C15F3C?style=for-the-badge)](https://claudekit.cc?ref=HMNKXOHN)
**Languages**: [English](README.md) | [Tiếng Việt](README.vi.md)
@@ -35,7 +35,7 @@ claude /login
**macOS / Linux / Windows**
```bash
npm install -g @kai/ccs
npm install -g @kaitranntt/ccs
```
Compatible with npm, yarn, pnpm, and bun package managers.
@@ -73,16 +73,16 @@ All major package managers are supported:
```bash
# npm (default)
npm install -g @kai/ccs
npm install -g @kaitranntt/ccs
# yarn
yarn global add @kai/ccs
yarn global add @kaitranntt/ccs
# pnpm (70% less disk space)
pnpm add -g @kai/ccs
pnpm add -g @kaitranntt/ccs
# bun (30x faster)
bun add -g @kai/ccs
bun add -g @kaitranntt/ccs
```
### Configuration (Auto-created)
+7 -7
View File
@@ -6,20 +6,20 @@
**macOS / Linux / Windows**
```bash
npm install -g @kai/ccs
npm install -g @kaitranntt/ccs
```
**Compatible with all package managers:**
- `npm install -g @kai/ccs`
- `yarn global add @kai/ccs`
- `pnpm add -g @kai/ccs`
- `bun add -g @kai/ccs`
- `npm install -g @kaitranntt/ccs`
- `yarn global add @kaitranntt/ccs`
- `pnpm add -g @kaitranntt/ccs`
- `bun add -g @kaitranntt/ccs`
**Benefits of npm installation:**
- ✅ Cross-platform compatibility
- ✅ Automatic PATH configuration
- ✅ Easy updates: `npm update -g @kai/ccs`
- ✅ Clean uninstall: `npm uninstall -g @kai/ccs`
- ✅ Easy updates: `npm update -g @kaitranntt/ccs`
- ✅ Clean uninstall: `npm uninstall -g @kaitranntt/ccs`
- ✅ Version pinning support
- ✅ Dependency management
+6 -6
View File
@@ -136,7 +136,7 @@ CCS is a lightweight CLI wrapper for instant switching between Claude Sonnet 4.5
- ✅ Added version synchronization scripts (sync-version.js, check-executables.js)
- ✅ Comprehensive testing of all installation methods (npm, curl, irm, git)
- ✅ Code review passed with 9.7/10 rating
- ✅ npm package ready for publication: `npm install -g @kai/ccs`
- ✅ npm package ready for publication: `npm install -g @kaitranntt/ccs`
**Key npm Package Features:**
- Cross-platform package distribution via npm registry
@@ -235,7 +235,7 @@ CCS is a lightweight CLI wrapper for instant switching between Claude Sonnet 4.5
#### Installation Method Strategy
**Primary Recommended Method:**
- `npm install -g @kai/ccs` (cross-platform, automatic updates)
- `npm install -g @kaitranntt/ccs` (cross-platform, automatic updates)
**Traditional Methods (Maintained for compatibility):**
- macOS/Linux: `curl -fsSL ccs.kaitran.ca/install | bash`
@@ -376,7 +376,7 @@ CCS is a lightweight CLI wrapper for instant switching between Claude Sonnet 4.5
- **Compatibility Matrix**: Windows PowerShell 5.1/7+, macOS/Linux bash/Node.js - all working
#### Installation Methods (All Enhanced)
- **npm (Recommended)**: `npm install -g @kai/ccs` - Now with standalone Node.js implementation
- **npm (Recommended)**: `npm install -g @kaitranntt/ccs` - Now with standalone Node.js implementation
- **Traditional Unix**: `curl -fsSL ccs.kaitran.ca/install | bash` - PowerShell 7+ compatible
- **Traditional Windows**: `irm ccs.kaitran.ca/install | iex` - PowerShell 7+ compatible
- **Git Development**: `./installers/install.sh` - Enhanced with better error handling
@@ -391,10 +391,10 @@ CCS is a lightweight CLI wrapper for instant switching between Claude Sonnet 4.5
- **Installation**: npm package now supports cross-platform distribution
#### Added
- **npm Package Support**: `npm install -g @kai/ccs` for easy cross-platform installation
- **npm Package Support**: `npm install -g @kaitranntt/ccs` for easy cross-platform installation
- **Cross-Platform Entry Point**: `bin/ccs.js` Node.js wrapper with platform detection
- **Version Management**: `scripts/sync-version.js` and `scripts/check-executables.js` for consistency
- **Package Metadata**: Complete package.json with bin field and scoped package name (@kai/ccs)
- **Package Metadata**: Complete package.json with bin field and scoped package name (@kaitranntt/ccs)
#### Changed
- **Directory Structure**: `ccs` and `ccs.ps1` moved to `lib/` directory
@@ -416,7 +416,7 @@ CCS is a lightweight CLI wrapper for instant switching between Claude Sonnet 4.5
- **Breaking Changes**: Only affects package structure, CLI functionality unchanged
#### Installation Methods (All Working)
- **npm (Recommended)**: `npm install -g @kai/ccs`
- **npm (Recommended)**: `npm install -g @kaitranntt/ccs`
- **Traditional Unix**: `curl -fsSL ccs.kaitran.ca/install | bash`
- **Traditional Windows**: `irm ccs.kaitran.ca/install | iex`
- **Git Development**: `./installers/install.sh`