@kimuson/claude-code-viewer 0.6.0-beta.1 → 0.6.0-beta.3

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 CHANGED
@@ -82,6 +82,7 @@ Options:
82
82
  -P, --password <password> Password for authentication
83
83
  -e, --executable <executable> Path to Claude Code executable
84
84
  --claude-dir <claude-dir> Path to Claude directory
85
+ --api-only Run in API-only mode without Web UI
85
86
  ```
86
87
 
87
88
  ### Docker Deployment
@@ -162,12 +163,22 @@ Claude Code Viewer can be configured using command-line options or environment v
162
163
  | `--terminal-disabled` | `CCV_TERMINAL_DISABLED` | Disable the in-app terminal panel when set to `1`/`true` (env) or when the flag is present (CLI) | (unset) |
163
164
  | `--terminal-shell <path>` | `CCV_TERMINAL_SHELL` | Shell executable for terminal sessions (e.g. `/bin/zsh`) | (auto-detect) |
164
165
  | `--terminal-unrestricted` | `CCV_TERMINAL_UNRESTRICTED` | When set to `1` (env) or when the flag is present (CLI), disables the restricted shell flags for bash | (unset) |
166
+ | `--api-only` | `CCV_API_ONLY` | Run in API-only mode. Disables Web UI, terminal WebSocket, and non-essential endpoints. Only core API routes (`/api/version`, `/api/config`, `/api/projects`, `/api/claude-code`, `/api/search`, `/api/sse`) are exposed. Useful for integrating with external tools like n8n | (unset) |
165
167
 
166
168
  **Breaking Change**: Environment variable names have been changed. If you're using environment variables, update them as follows:
167
169
  - `CLAUDE_CODE_VIEWER_AUTH_PASSWORD` → `CCV_PASSWORD`
168
170
  - `CLAUDE_CODE_VIEWER_CC_EXECUTABLE_PATH` → `CCV_CC_EXECUTABLE_PATH`
169
171
  - New environment variable added: `CCV_GLOBAL_CLAUDE_DIR` (previously the Claude directory path was hardcoded to `~/.claude`)
170
172
 
173
+ ### API Authentication
174
+
175
+ When `--password` / `CCV_PASSWORD` is set, all `/api` routes (except auth-related endpoints) require authentication. You can authenticate in two ways:
176
+
177
+ 1. **Session cookie**: Use the `/api/auth/login` endpoint to set the `ccv-session` cookie, then include it in subsequent requests.
178
+ 2. **Authorization header**: Send `Authorization: Bearer <password>` on each request.
179
+
180
+ If no password is configured, API authentication is disabled.
181
+
171
182
  ### User Settings
172
183
 
173
184
  Settings can be configured from the sidebar in Claude Code Viewer.