mirror of
https://github.com/ohmyzsh/ohmyzsh.git
synced 2026-03-29 19:14:05 +08:00
feat(claude-code): add initial plugin implementation with aliases, helpers, and tab completion
This commit is contained in:
Mauricio Silva
parent
44394e7225
commit
be45d31acb
91
plugins/claude-code/README.md
Normal file
91
plugins/claude-code/README.md
Normal file
@ -0,0 +1,91 @@
|
||||
# Claude Code Plugin
|
||||
|
||||
The `claude-code` plugin adds several aliases and helper functions for [Claude Code](https://github.com/anthropics/claude-code), the CLI for Claude.
|
||||
|
||||
To use it, add `claude-code` to the plugins array of your zshrc file:
|
||||
|
||||
```zsh
|
||||
plugins=(... claude-code)
|
||||
```
|
||||
|
||||
## Aliases
|
||||
|
||||
### Core
|
||||
|
||||
| Alias | Command | Description |
|
||||
|-------|---------|-------------|
|
||||
| `cl` | `claude` | Start interactive session |
|
||||
| `clc` | `claude --continue` | Continue last conversation |
|
||||
| `clr` | `claude --resume` | Open session picker |
|
||||
| `clp` | `claude -p` | Headless/print mode |
|
||||
| `clv` | `claude --version` | Show version |
|
||||
| `clu` | `claude update` | Update Claude Code |
|
||||
|
||||
### Sessions
|
||||
|
||||
| Alias | Command | Description |
|
||||
|-------|---------|-------------|
|
||||
| `cln` | `claude -n` | Start a named session |
|
||||
| `clw` | `claude -w` | Start in a git worktree |
|
||||
| `clfork` | `claude --fork-session` | Fork current session |
|
||||
|
||||
### Auth
|
||||
|
||||
| Alias | Command | Description |
|
||||
|-------|---------|-------------|
|
||||
| `clas` | `claude auth status` | Check auth status |
|
||||
| `clal` | `claude auth login` | Sign in |
|
||||
| `clao` | `claude auth logout` | Sign out |
|
||||
|
||||
### Config
|
||||
|
||||
| Alias | Command | Description |
|
||||
|-------|---------|-------------|
|
||||
| `clmcp` | `claude mcp` | Manage MCP servers |
|
||||
| `clag` | `claude agents` | List configured agents |
|
||||
|
||||
### Channels
|
||||
|
||||
| Alias | Command | Description | Plugin Install |
|
||||
|-------|---------|-------------|----------------|
|
||||
| `clch-tg` | `claude --channels plugin:telegram@...` | Start with Telegram channel | `/plugin install telegram@claude-plugins-official` |
|
||||
| `clch-dc` | `claude --channels plugin:discord@...` | Start with Discord channel | `/plugin install discord@claude-plugins-official` |
|
||||
| `clch <spec>` | `claude --channels <spec>` | Start with custom channel | — |
|
||||
|
||||
## Functions
|
||||
|
||||
| Function | Description | Example |
|
||||
|----------|-------------|---------|
|
||||
| `clm <model>` | Start with a specific model | `clm opus` |
|
||||
| `cle <effort>` | Start with a specific effort level | `cle high` |
|
||||
| `clds` | Directory session — create/resume a session named after `$PWD` | `cd my-project && clds` |
|
||||
| `clfp <pr>` | Resume sessions linked to a GitHub PR | `clfp 123` |
|
||||
|
||||
|
||||
|
||||
## Configuration Variables
|
||||
|
||||
Set these in your `~/.zshrc` before the plugins line:
|
||||
|
||||
| Variable | Default | Description |
|
||||
|----------|---------|-------------|
|
||||
| `ZSH_CLAUDE_DEFAULT_MODEL` | (unset) | Default model for `clm` and `_claude_with_defaults` |
|
||||
| `ZSH_CLAUDE_DEFAULT_EFFORT` | (unset) | Default effort level |
|
||||
| `ZSH_CLAUDE_DEFAULT_PERMISSION_MODE` | (unset) | Default permission mode (plan/auto/manual) |
|
||||
| `ZSH_CLAUDE_AUTO_CONTINUE` | `false` | Auto-continue last session when opening a new shell |
|
||||
|
||||
### Example configuration
|
||||
|
||||
```zsh
|
||||
# ~/.zshrc
|
||||
ZSH_CLAUDE_DEFAULT_MODEL="sonnet"
|
||||
ZSH_CLAUDE_DEFAULT_EFFORT="high"
|
||||
ZSH_CLAUDE_AUTO_CONTINUE=false
|
||||
|
||||
plugins=(... claude-code)
|
||||
```
|
||||
|
||||
## Tab Completion
|
||||
|
||||
- `clm [TAB]` — completes model names (opus, sonnet, haiku)
|
||||
- `cle [TAB]` — completes effort levels (low, medium, high, max)
|
||||
163
plugins/claude-code/claude-code.plugin.zsh
Normal file
163
plugins/claude-code/claude-code.plugin.zsh
Normal file
@ -0,0 +1,163 @@
|
||||
# Claude Code - Oh My Zsh Plugin
|
||||
# Aliases and helpers for the Claude Code CLI
|
||||
# https://github.com/anthropics/claude-code
|
||||
|
||||
# Prerequisite check
|
||||
|
||||
if ! (( $+commands[claude] )); then
|
||||
print "zsh claude-code plugin: claude not found. Install Claude Code: npm install -g @anthropic-ai/claude-code" >&2
|
||||
return 1
|
||||
fi
|
||||
|
||||
# Configuration variables
|
||||
|
||||
: ${ZSH_CLAUDE_DEFAULT_MODEL:=}
|
||||
: ${ZSH_CLAUDE_DEFAULT_EFFORT:=}
|
||||
: ${ZSH_CLAUDE_DEFAULT_PERMISSION_MODE:=}
|
||||
: ${ZSH_CLAUDE_AUTO_CONTINUE:=false}
|
||||
|
||||
# Core aliases
|
||||
|
||||
alias cl='claude'
|
||||
alias clc='claude --continue'
|
||||
alias clr='claude --resume'
|
||||
alias clp='claude -p'
|
||||
alias clv='claude --version'
|
||||
alias clu='claude update'
|
||||
|
||||
# Session aliases
|
||||
|
||||
alias cln='claude -n'
|
||||
alias clw='claude -w'
|
||||
alias clfork='claude --fork-session'
|
||||
|
||||
# Auth aliases
|
||||
|
||||
alias clas='claude auth status'
|
||||
alias clal='claude auth login'
|
||||
alias clao='claude auth logout'
|
||||
|
||||
# Config aliases
|
||||
|
||||
alias clmcp='claude mcp'
|
||||
alias clag='claude agents'
|
||||
|
||||
# Model & effort aliases
|
||||
|
||||
function clm() {
|
||||
local model="${1:-${ZSH_CLAUDE_DEFAULT_MODEL}}"
|
||||
if [[ -z "$model" ]]; then
|
||||
print "Usage: clm <model> (opus, sonnet, haiku, or full model ID)" >&2
|
||||
return 1
|
||||
fi
|
||||
shift 2>/dev/null
|
||||
claude --model "$model" "$@"
|
||||
}
|
||||
|
||||
function cle() {
|
||||
local effort="${1:-${ZSH_CLAUDE_DEFAULT_EFFORT}}"
|
||||
if [[ -z "$effort" ]]; then
|
||||
print "Usage: cle <effort> (low, medium, high, max)" >&2
|
||||
return 1
|
||||
fi
|
||||
shift 2>/dev/null
|
||||
claude --effort "$effort" "$@"
|
||||
}
|
||||
|
||||
# Channel aliases
|
||||
|
||||
alias clch-tg='claude --channels plugin:telegram@claude-plugins-official'
|
||||
alias clch-dc='claude --channels plugin:discord@claude-plugins-official'
|
||||
|
||||
function clch() {
|
||||
if [[ -z "$1" ]]; then
|
||||
print "Usage: clch <channel-spec> [claude-args...]" >&2
|
||||
print " e.g. clch plugin:telegram@claude-plugins-official" >&2
|
||||
return 1
|
||||
fi
|
||||
local channel="$1"
|
||||
shift
|
||||
claude --channels "$channel" "$@"
|
||||
}
|
||||
|
||||
# Helper functions
|
||||
|
||||
# Directory session: create or resume a session named after the current directory
|
||||
# Similar to tmux's tds alias
|
||||
function clds() {
|
||||
local dir="${PWD##*/}"
|
||||
[[ "$PWD" == "$HOME" ]] && dir="HOME"
|
||||
[[ "$PWD" == "/" ]] && dir="ROOT"
|
||||
claude --resume "$dir" "$@" 2>/dev/null || claude -n "$dir" "$@"
|
||||
}
|
||||
|
||||
# Resume from a PR number
|
||||
function clfp() {
|
||||
if [[ -z "$1" ]]; then
|
||||
print "Usage: clfp <pr-number>" >&2
|
||||
return 1
|
||||
fi
|
||||
claude --from-pr "$1"
|
||||
}
|
||||
|
||||
# Start claude with default config variables applied
|
||||
function _claude_with_defaults() {
|
||||
local -a args
|
||||
args=()
|
||||
|
||||
[[ -n "$ZSH_CLAUDE_DEFAULT_MODEL" ]] && args+=(--model "$ZSH_CLAUDE_DEFAULT_MODEL")
|
||||
[[ -n "$ZSH_CLAUDE_DEFAULT_EFFORT" ]] && args+=(--effort "$ZSH_CLAUDE_DEFAULT_EFFORT")
|
||||
[[ -n "$ZSH_CLAUDE_DEFAULT_PERMISSION_MODE" ]] && args+=(--permission-mode "$ZSH_CLAUDE_DEFAULT_PERMISSION_MODE")
|
||||
|
||||
claude "${args[@]}" "$@"
|
||||
}
|
||||
|
||||
# Tab completion
|
||||
|
||||
function _claude_code_models() {
|
||||
local -a models
|
||||
models=(
|
||||
'opus:Claude Opus (most capable)'
|
||||
'sonnet:Claude Sonnet (balanced)'
|
||||
'haiku:Claude Haiku (fastest)'
|
||||
)
|
||||
_describe 'model' models
|
||||
}
|
||||
|
||||
function _claude_code_efforts() {
|
||||
local -a efforts
|
||||
efforts=(
|
||||
'low:Minimal reasoning'
|
||||
'medium:Balanced reasoning'
|
||||
'high:Deep reasoning'
|
||||
'max:Maximum reasoning depth'
|
||||
)
|
||||
_describe 'effort' efforts
|
||||
}
|
||||
|
||||
function _claude_code_permission_modes() {
|
||||
local -a modes
|
||||
modes=(
|
||||
'plan:Plan mode - confirm before actions'
|
||||
'auto:Auto mode - approve safe actions'
|
||||
'manual:Manual mode - approve everything'
|
||||
)
|
||||
_describe 'permission-mode' modes
|
||||
}
|
||||
|
||||
function _clm() {
|
||||
_arguments '1:model:_claude_code_models' '*::args:'
|
||||
}
|
||||
|
||||
function _cle() {
|
||||
_arguments '1:effort:_claude_code_efforts' '*::args:'
|
||||
}
|
||||
|
||||
compdef _clm clm
|
||||
compdef _cle cle
|
||||
|
||||
# Auto-continue on shell start
|
||||
|
||||
if [[ "$ZSH_CLAUDE_AUTO_CONTINUE" == "true" && -z "$CLAUDECODE" ]]; then
|
||||
claude --continue 2>/dev/null
|
||||
fi
|
||||
Loading…
Reference in New Issue
Block a user