Usage

0. SSH into the server

Connect to your server as root:

ssh root@<SERVER_IP>

1. Switch to the application user

All Paperclip operations must run under the dedicated user:

su - paperclip

Do NOT run Paperclip as root.

2. First-time setup (onboarding wizard)

Run the interactive setup:

paperclipai onboard

This configures your instance for first use.

3. Start Paperclip

Launch the application:

paperclipai run

To keep it running after logout, use tools like tmux

4. Default services

Once running (unless reconfigured), the system exposes:

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

These are the default settings and will apply unless you explicitly change the binding, port, or domain during configuration.

5. Useful commands

# Help / CLI reference
paperclipai --help

# Diagnose issues
paperclipai doctor

# Reconfigure setup
paperclipai configure

# Print environment variables for deployment
paperclipai env

6. Access the UI securely (SSH tunneling)

From your local machine, run:

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

/root/.cloudzy-creds

Điều hướng đến http://127.0.0.1:3100 in your local browser to access the Paperclip UI.

Ensure Paperclip is running on the server, otherwise the UI and API will not be accessible.

Các tuyến đường quan trọng

Home directory: /home/paperclip
Cấu hình: /home/paperclip/.paperclip/instances/default/config.json
Logs/data: /home/paperclip/.paperclip/
NVM directory: /home/paperclip/.nvm/

Ghi chú

Do not run paperclipai commands as root (always run under the paperclip user)
Cái paperclip user credentials are stored securely in /root/.cloudzy-creds
You can also log in directly as the paperclip user using SSH: ssh paperclip@<SERVER_IP>
When logged in as root, always switch to the application user before running any Paperclip commands: su - paperclip
Run onboard only on first setup
Sử dụng configure later for changes

Paperclip