Skip to content

Commit 28cace5

Browse files
Ark0Nclaude
andcommitted
docs: clean up README install and service sections
Remove fork/branch install instructions and env vars table for cleaner first impression. Reformat systemd and launchd service blocks as readable multi-line heredocs. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 0a594b6 commit 28cace5

1 file changed

Lines changed: 43 additions & 20 deletions

File tree

README.md

Lines changed: 43 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -30,24 +30,6 @@ curl -fsSL https://raw.githubusercontent.com/Ark0N/Codeman/master/install.sh | b
3030

3131
This installs Node.js and tmux if missing, clones Codeman to `~/.codeman/app`, and builds it.
3232

33-
**Install from a fork or specific branch:**
34-
```bash
35-
curl -fsSL https://raw.githubusercontent.com/<user>/Codeman/<branch>/install.sh | \
36-
CODEMAN_REPO_URL=https://github.com/<user>/Codeman.git \
37-
CODEMAN_BRANCH=<branch> bash
38-
```
39-
40-
The installer supports these environment variables:
41-
42-
| Variable | Default | Description |
43-
|----------|---------|-------------|
44-
| `CODEMAN_REPO_URL` | upstream Codeman | Custom git repository URL |
45-
| `CODEMAN_BRANCH` | `master` | Git branch to install |
46-
| `CODEMAN_INSTALL_DIR` | `~/.codeman/app` | Custom install directory |
47-
| `CODEMAN_SKIP_SYSTEMD` | `0` | Skip systemd service setup prompt |
48-
| `CODEMAN_NODE_VERSION` | `22` | Node.js major version to install |
49-
| `CODEMAN_NONINTERACTIVE` | `0` | Skip all prompts (for CI/automation) |
50-
5133
You'll need at least one AI coding CLI installed — [Claude Code](https://docs.anthropic.com/en/docs/claude-code) or [OpenCode](https://opencode.ai) (or both). After install:
5234

5335
```bash
@@ -60,12 +42,53 @@ codeman web
6042

6143
**Linux (systemd):**
6244
```bash
63-
mkdir -p ~/.config/systemd/user && printf '[Unit]\nDescription=Codeman Web Server\nAfter=network.target\n\n[Service]\nType=simple\nExecStart=%s %s/dist/index.js web\nRestart=always\nRestartSec=10\n\n[Install]\nWantedBy=default.target\n' "$(which node)" "$HOME/.codeman/app" > ~/.config/systemd/user/codeman-web.service && systemctl --user daemon-reload && systemctl --user enable --now codeman-web && loginctl enable-linger $USER
45+
mkdir -p ~/.config/systemd/user
46+
cat > ~/.config/systemd/user/codeman-web.service << EOF
47+
[Unit]
48+
Description=Codeman Web Server
49+
After=network.target
50+
51+
[Service]
52+
Type=simple
53+
ExecStart=$(which node) $HOME/.codeman/app/dist/index.js web
54+
Restart=always
55+
RestartSec=10
56+
57+
[Install]
58+
WantedBy=default.target
59+
EOF
60+
systemctl --user daemon-reload
61+
systemctl --user enable --now codeman-web
62+
loginctl enable-linger $USER
6463
```
6564

6665
**macOS (launchd):**
6766
```bash
68-
mkdir -p ~/Library/LaunchAgents && printf '<?xml version="1.0" encoding="UTF-8"?>\n<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">\n<plist version="1.0"><dict><key>Label</key><string>com.codeman.web</string><key>ProgramArguments</key><array><string>%s</string><string>%s/dist/index.js</string><string>web</string></array><key>RunAtLoad</key><true/><key>KeepAlive</key><true/><key>StandardOutPath</key><string>/tmp/codeman.log</string><key>StandardErrorPath</key><string>/tmp/codeman.log</string></dict></plist>\n' "$(which node)" "$HOME/.codeman/app" > ~/Library/LaunchAgents/com.codeman.web.plist && launchctl load ~/Library/LaunchAgents/com.codeman.web.plist
67+
mkdir -p ~/Library/LaunchAgents
68+
cat > ~/Library/LaunchAgents/com.codeman.web.plist << EOF
69+
<?xml version="1.0" encoding="UTF-8"?>
70+
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN"
71+
"http://www.apple.com/DTDs/PropertyList-1.0.dtd">
72+
<plist version="1.0">
73+
<dict>
74+
<key>Label</key>
75+
<string>com.codeman.web</string>
76+
<key>ProgramArguments</key>
77+
<array>
78+
<string>$(which node)</string>
79+
<string>$HOME/.codeman/app/dist/index.js</string>
80+
<string>web</string>
81+
</array>
82+
<key>RunAtLoad</key><true/>
83+
<key>KeepAlive</key><true/>
84+
<key>StandardOutPath</key>
85+
<string>/tmp/codeman.log</string>
86+
<key>StandardErrorPath</key>
87+
<string>/tmp/codeman.log</string>
88+
</dict>
89+
</plist>
90+
EOF
91+
launchctl load ~/Library/LaunchAgents/com.codeman.web.plist
6992
```
7093
</details>
7194

0 commit comments

Comments
 (0)