cloudpen-cli

Official CLI for Cloudpen — manage projects, push files, pull changes, and run builds directly from your terminal.

Installation

npm install -g cloudpen-cli

Requires Node.js 18 or higher.

Quick Start

# 1. Authenticate with your Cloudpen API token
cloudpen login

# 2. Clone a project to your machine
cloudpen clone acme/my-project

# 3. Make changes, then push them back
cd my-project
cloudpen push

Authentication

cloudpen login      # Save your API token
cloudpen whoami     # Confirm who you're logged in as
cloudpen logout     # Remove saved credentials

Your API token is available in your Cloudpen dashboard under Settings → API Tokens.

Commands

cloudpen login

Authenticate with your personal API token. Credentials are saved locally and reused for all subsequent commands.

cloudpen logout

Remove your saved credentials from the local machine.

cloudpen whoami

Print the currently authenticated user.

cloudpen clone <workspace>/<slug> [destination]

Clone any project you have access to into a new local folder. No init required.

cloudpen clone acme/my-project
cloudpen clone acme/my-project my-local-name   # optional custom folder name

The cloned folder is automatically linked to the project, so you can push and pull immediately.

cloudpen init

Link an existing local folder to one of your Cloudpen projects. Lets you choose from a list of your projects interactively.

cd my-folder
cloudpen init

cloudpen project

Show information about the project linked to the current directory — name, visibility, file count, size, stars, forks, views, and more.

cloudpen project

  acme/my-project  [private]  [react]

  ★ 12 stars  ·  ⑂ 3 forks  ·  ◎ 47 views

  Workspace   acme
  Slug        my-project
  Files       9 files  1.2 KB
  Updated     Apr 25, 2026
  Author      acme

cloudpen projects

List all your projects.

cloudpen projects

cloudpen create

Create a new Cloudpen project interactively. Prompts for name, template, and visibility.

cloudpen create

cloudpen push [file]

Upload local files to the linked project. By default pushes all changed files. Pass a path to push a single file.

cloudpen push                    # push all files
cloudpen push src/index.js       # push a single file
cloudpen push --create           # create new files that don't exist yet on the server

| Flag | Description | |------|-------------| | --create, -c | Create files on the server that don't exist yet |

cloudpen pull [file]

Download the latest files from the linked project to your local folder.

cloudpen pull                    # pull all files
cloudpen pull src/index.js       # pull a single file
cloudpen pull --force            # skip overwrite confirmation

| Flag | Description | |------|-------------| | --force, -f | Skip the overwrite confirmation prompt |

cloudpen files

List all files in the linked project.

cloudpen files

cloudpen run

Trigger a run or build for the linked project.

cloudpen run

Ignoring Files

Create a .cloudpenignore file in your project root to exclude files and folders from being pushed. It works exactly like .gitignore.

# Dependencies
node_modules/
vendor/

# Build output
dist/
.next/
build/

# Environment & secrets
.env
.env.*
!.env.example

Running cloudpen init automatically creates a sensible .cloudpenignore for you.

Local Config

When you init or clone a project, a .cloudpen file is created in the project root. It stores the linked project info:

{
  "project_slug": "my-project",
  "project_name": "My Project",
  "workspace": "acme"
}

Add .cloudpen to your .gitignore — it's machine-local config, not source code.

Options

| Flag | Description | |------|-------------| | --help, -h | Show help | | --version, -v | Show version | | --force, -f | Skip confirmations (pull) | | --create, -c | Create new files (push) |

Examples

# Clone a public project and start editing
cloudpen clone acme/landing-page
cd landing-page
# ... make changes ...
cloudpen push

# Check what project the current folder is linked to
cloudpen project

# Link an existing folder and push your files
cd ~/my-app
cloudpen init
cloudpen push --create

# Pull the latest changes before editing
cloudpen pull --force

Links

• Website: cloudpen.dev
• Dashboard: app.cloudpen.dev
• Issues: github.com/cloudpen/cli

License

ISC