CLI Commands

Complete reference for the bp command-line tool.

Installation

curl -fsSL https://pod.base.al/cli | bash

Global Options

-h, --help      Show help
-v, --version   Show version

Authentication

login

Login to a Basepod server.

bp login <server>

Arguments:

• server - Server URL (e.g., myserver.com or https://myserver.com)

Example:

bp login pod.example.com
# Enter password when prompted

logout

Logout from the current server.

bp logout [name]

Arguments:

• name - (Optional) Context name to logout from

context

List or switch server contexts.

bp context [name]

Arguments:

• name - (Optional) Context to switch to

Examples:

# List all contexts
bp context

# Switch to a context
bp context production

App Management

apps

List all apps on the current server.

bp apps

Aliases: app, list, ls

create

Create a new app.

bp create <name> [options]

Arguments:

• name - App name

Options:

• --domain, -d - Custom domain
• --port, -p - Container port
• --image, -i - Docker image

Examples:

bp create myapp
bp create myapp --domain myapp.example.com
bp create myapp --image nginx:latest --port 80

delete

Delete an app.

bp delete <name>

Aliases: rm

Deployment

init

Initialize a basepod.yaml config file.

bp init [path]

Arguments:

• path - (Optional) Directory path, defaults to current directory

push

Deploy from local source.

bp push [path]

Arguments:

• path - (Optional) Source directory, defaults to current directory

Example:

# Deploy current directory
bp push

# Deploy specific path
bp push ./myapp

deploy

Deploy with a Docker image or Git URL.

bp deploy <name> [options]

Arguments:

• name - App name

Options:

• --image, -i - Docker image
• --git, -g - Git repository URL
• --branch, -b - Git branch

Examples:

bp deploy myapp --image nginx:latest
bp deploy myapp --git https://github.com/user/repo.git
bp deploy myapp --git https://github.com/user/repo.git --branch develop

App Operations

start

Start a stopped app.

bp start <name>

stop

Stop a running app.

bp stop <name>

restart

Restart an app.

bp restart <name>

logs

View app logs.

bp logs <name> [options]

Options:

• --tail, -n - Number of lines (default: 100)

Examples:

bp logs myapp
bp logs myapp --tail 500
bp logs myapp -n 50

Server Info

info

Show server information.

bp info

Configuration File

The basepod.yaml file in your project root:

name: myapp
server: pod.example.com    # Optional: specific server context
domain: custom.example.com # Optional: custom domain
port: 3000                 # Container port

build:
  dockerfile: Dockerfile
  context: .

env:
  NODE_ENV: production
  API_KEY: secret

volumes:
  - data:/app/data

Environment Variables

• BASEPOD_SERVER - Default server URL
• BASEPOD_TOKEN - Authentication token

Exit Codes

Code	Description
0	Success
1	General error
2	Invalid arguments
3	Authentication error
4	Network error