@ccdevkit/ccyolo 0.25.0 → 0.25.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.
Files changed (2) hide show
  1. package/README.md +72 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -95,6 +95,78 @@ When you paste or drag a file, ccyolo intercepts the input, copies the file into
95
95
 
96
96
  If you need clipboard support on ARM64, you can build from source on a native ARM64 machine with CGO enabled.
97
97
 
98
+ ## Settings
99
+
100
+ ccyolo can be configured using a settings file in your project or home directory. Settings files are discovered by walking up from your current directory to root.
101
+
102
+ ### Settings file location
103
+
104
+ Create a settings file at `.ccdevkit/ccyolo/settings.json` (or `.yaml`/`.yml`) in your project directory or home directory:
105
+
106
+ ```
107
+ your-project/
108
+ .ccdevkit/
109
+ ccyolo/
110
+ settings.json # Project-specific settings
111
+ ```
112
+
113
+ Or in your home directory for global settings:
114
+
115
+ ```
116
+ ~/.ccdevkit/
117
+ ccyolo/
118
+ settings.json # Global settings
119
+ ```
120
+
121
+ ### Available settings
122
+
123
+ ```json
124
+ {
125
+ "claudePath": "/path/to/claude",
126
+ "passthrough": ["git", "docker", "gh"]
127
+ }
128
+ ```
129
+
130
+ | Setting | Type | Description |
131
+ |---------|------|-------------|
132
+ | `claudePath` | string | Path to the claude CLI executable (default: `claude` in PATH) |
133
+ | `passthrough` | array | List of command prefixes to run on the host instead of in the container |
134
+
135
+ ### Settings priority
136
+
137
+ Settings are merged with the following priority (highest to lowest):
138
+
139
+ 1. Command-line flags
140
+ 2. Project settings (`.ccdevkit/ccyolo/settings.json` in current directory or ancestors)
141
+ 3. Global settings (`~/.ccdevkit/ccyolo/settings.json`)
142
+ 4. Defaults
143
+
144
+ ### Example configurations
145
+
146
+ **Minimal setup:**
147
+ ```json
148
+ {
149
+ "passthrough": ["git"]
150
+ }
151
+ ```
152
+
153
+ **Advanced setup:**
154
+ ```json
155
+ {
156
+ "claudePath": "/usr/local/bin/claude",
157
+ "passthrough": ["git", "docker", "gh", "npm"]
158
+ }
159
+ ```
160
+
161
+ **YAML format:**
162
+ ```yaml
163
+ claudePath: /usr/local/bin/claude
164
+ passthrough:
165
+ - git
166
+ - docker
167
+ - gh
168
+ ```
169
+
98
170
  ## Requirements
99
171
 
100
172
  - Docker
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ccdevkit/ccyolo",
3
- "version": "0.25.0",
3
+ "version": "0.25.1",
4
4
  "description": "Run Claude Code in a Docker container with YOLO mode enabled",
5
5
  "bin": {
6
6
  "ccyolo": "bin/ccyolo"