@siteboon/claude-code-ui 1.9.0 → 1.10.0

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
@@ -67,7 +67,49 @@ No installation required, direct operation:
67
67
  npx @siteboon/claude-code-ui
68
68
  ```
69
69
 
70
- Your default browser will automatically open the Claude Code UI interface.
70
+ The server will start and be accessible at `http://localhost:3001` (or your configured PORT).
71
+
72
+ **To restart**: Simply run the same `npx` command again after stopping the server (Ctrl+C or Cmd+C).
73
+
74
+ ### Global Installation (For Regular Use)
75
+
76
+ For frequent use, install globally once:
77
+
78
+ ```bash
79
+ npm install -g @siteboon/claude-code-ui
80
+ ```
81
+
82
+ Then start with a simple command:
83
+
84
+ ```bash
85
+ claude-code-ui
86
+ ```
87
+
88
+ **Benefits**:
89
+ - Faster startup (no download/cache check)
90
+ - Simple command to remember
91
+ - Same experience every time
92
+
93
+ **To restart**: Stop with Ctrl+C and run `claude-code-ui` again.
94
+
95
+ ### Run as Background Service (Optional)
96
+
97
+ To keep the server running in the background, use PM2:
98
+
99
+ ```bash
100
+ # Install PM2 globally (one-time)
101
+ npm install -g pm2
102
+
103
+ # Start the server
104
+ pm2 start claude-code-ui --name "claude-ui"
105
+
106
+ # Manage the service
107
+ pm2 list # View status
108
+ pm2 restart claude-ui # Restart
109
+ pm2 stop claude-ui # Stop
110
+ pm2 logs claude-ui # View logs
111
+ pm2 startup # Auto-start on system boot
112
+ ```
71
113
 
72
114
  ### Local Development Installation
73
115
 
@@ -236,13 +278,13 @@ We welcome contributions! Please follow these guidelines:
236
278
 
237
279
  ### Common Issues & Solutions
238
280
 
281
+
239
282
  #### "No Claude projects found"
240
283
  **Problem**: The UI shows no projects or empty project list
241
284
  **Solutions**:
242
285
  - Ensure [Claude CLI](https://docs.anthropic.com/en/docs/claude-code) is properly installed
243
286
  - Run `claude` command in at least one project directory to initialize
244
287
  - Verify `~/.claude/projects/` directory exists and has proper permissions
245
- d
246
288
 
247
289
  #### File Explorer Issues
248
290
  **Problem**: Files not loading, permission errors, empty directories