Paperclip

Usage

0. 通过 SSH 连接服务器

以 root 身份连接到服务器：

ssh root@<SERVER_IP>

使用密码登录。

1. 切换到应用用户

所有 Paperclip 操作必须在专用用户下运行：

su - paperclip

请勿以 root 身份运行 Paperclip。

2. 初始配置（引导向导）

运行交互式配置：

paperclipai onboard

此步骤将为首次使用配置您的实例。

3. Start Paperclip

启动应用程序：

paperclipai run

若需在退出登录后保持运行，请使用如 tmux

4. Default services

启动后（除非重新配置），系统将开放：

• API server → http://127.0.0.1:3100/api
• Health check → http://127.0.0.1:3100/api/health
• UI → http://127.0.0.1:3100

以上为默认设置，除非您在配置时明确修改绑定地址、端口或域名，否则将保持不变。

5. Useful commands

# Help / CLI reference
paperclipai --help

# Diagnose issues
paperclipai doctor

# Reconfigure setup
paperclipai configure

# Print environment variables for deployment
paperclipai env

6. 通过 SSH 隧道安全访问界面

在您的本地机器上运行：

ssh -L 3100:127.0.0.1:3100 paperclip@<SERVER_IP>

使用服务器上以下路径存储的凭据登录：

/root/.cloudzy-creds

Navigate to http://127.0.0.1:3100 在本地浏览器中访问 Paperclip 界面。

请确保 Paperclip 已在服务器上运行，否则界面和 API 将无法访问。

Important Paths

• Home directory: /home/paperclip
• Config: /home/paperclip/.paperclip/instances/default/config.json
• Logs/data: /home/paperclip/.paperclip/
• NVM directory: /home/paperclip/.nvm/

Notes

• Do not run paperclipai 命令以 root 身份运行（请始终在 paperclip user)
• The paperclip 用户凭据安全存储于 /root/.cloudzy-creds
• 您也可以直接以 paperclip 用户身份通过 SSH 登录： ssh paperclip@<SERVER_IP>
• 以 root 登录时，运行任何 Paperclip 命令前，请先切换至应用程序用户： su - paperclip
• Run onboard 仅在首次配置时执行
• Use configure 后续修改时执行