The official command-line interface for managing your Webdock.io resources.
webdock allows you to manage servers, SSH keys, events, and more directly from your terminal, making it easy to script, automate, and integrate your Webdock infrastructure into your workflows.
Before you can use webdock-cli, you need a Webdock API Token.
You can generate an API token from your Webdock account dashboard in the API Tokens section.
You can install webdock-cli using our convenient installer script. It will download the latest binary for your system and place it in /usr/local/bin.
curl -fsSL 'https://cli-src.webdock.tech/install/linux.sh' | sudo bashFor Windows, run the following command in an administrator PowerShell terminal. This will download and execute the installer script.
irm 'https://cli-src.webdock.tech/install/windows.ps1' | iexcurl -fsSL 'https://cli-src.webdock.tech/install/mac.sh' | sudo bash
Initialize the CLI with your API token.
webdock init -t <token>
-t, --token <token>: API token for authentication (required)
Manage account information.
info: Get account information-t, --token <token>: API token for authentication--json: Output as JSON--csv: Output as CSV
Manage account events.
list: List all events-t, --token <token>: API token for authentication-p, --page <page>: Page number (default: 1)-l, --limit <limit>: Events per page (default: 15)-y, --type <type>: Filter by event type--json: Output as JSON--csv: Output as CSV
Event Types: provision, restore-server, change-profile, set-state, delete, backup, set-hostnames, update-webroot, setup-ssl, install-wordpress, manage-wordpress, manage-shelluser, manage-keys, toggle-passwordauth, manage-mysql, manage-dbuser, manage-ftpuser, set-php-settings, cronjob, pull-file, push-file, delete-file, execute-file
Manage event hooks and callbacks.
list: List event hooks-t, --token <token>: API token--json,--csv
create <callbackUrl>: Create a new event hook-t, --token <token>: API token-i, --callback-id <id>: Optional callback ID-e, --event-type <eventType>: Optional event type--json,--csv
get <id>: Get details of a specific hook-t, --token <token>: API token--json,--csv
delete <id>: Delete an event hook-t, --token <token>: API token-f, --force: Force deletion
Manage server images.
list: List all images-t, --token <token>: API token--json,--csv
Manage server locations.
list: List all locations-t, --token <token>: API token--json,--csv
Manage server profiles.
list <locationId>: List all profiles for a location-t, --token <token>: API token--json,--csv
Manage account and server scripts.
list: List all account scripts-t, --token <token>: API token--json,--csv
create <name> <filename> <content>: Create an account script-t, --token <token>: API token--json,--csv
update <id> <name> <filename> <content>: Update an account script-t, --token <token>: API token--json,--csv
delete <id>: Delete an account script-t, --token <token>: API token
get <id>: Get an account script by ID-t, --token <token>: API token--json,--csv
server-list <serverSlug>: List scripts for a server-t, --token <token>: API token--json,--csv
server-create <serverSlug> <scriptId> <path>: Create a script on a server-t, --token <token>: API token-x, --executable: Make script executable-i, --executeImmediately: Run script after deployment--json,--csv
server-delete <serverSlug> <scriptId>: Delete a script from a server-t, --token <token>: API token
server-execute <serverSlug> <scriptId>: Execute a script on a server-t, --token <token>: API token--wait: Wait for completion
Manage servers.
list: List all servers-t, --token <token>: API token--json,--csv
get <slug>: Get details of a server-t, --token <token>: API token--json,--csv
create <name> <locationId> <profileSlug>: Create a server-t, --token <token>: API token-i, --imageSlug <imageSlug>: Image slug-v, --virtualization <virtualization>: Virtualization type-s, --slug <slug>: Custom slug-a, --snapshotId <snapshotId>: Restore from snapshot--wait: Wait for server to be ready--json,--csv
delete <serverSlug>: Delete a server-t, --token <token>: API token--wait: Wait for deletion
update <serverSlug> <name> <description> <notes> <nextActionDate>: Update server metadata-t, --token <token>: API token--json,--csv
start <serverSlug>: Start a server-t, --token <token>: API token--wait: Wait for server to start
stop <serverSlug>: Stop a server-t, --token <token>: API token--wait: Wait for server to stop
reboot <serverSlug>: Reboot a server-t, --token <token>: API token--wait: Wait for server to reboot
reinstall <serverSlug> <imageSlug>: Reinstall a server-t, --token <token>: API token--wait: Wait for reinstall
resize <serverSlug> <profileSlug>: Resize a server (change profile)-t, --token <token>: API token--wait: Wait for resize
resize-dryrun <serverSlug> <profile>: Preview server profile change-t, --token <token>: API token--json,--csv
metrics-now <serverSlug>: Get instant server metrics-t, --token <token>: API token--now: Get metrics now
archive <slug>: Archive a server-t, --token <token>: API token-f, --force: Force archive--wait: Wait for completion
fetch-file <slug> <path>: Fetch a file from a server-t, --token <token>: API token--wait: Wait for completion
Manage server shell users.
list <slug>: List shell users for a server-t, --token <token>: API token--json,--csv
create <slug> <username> <password>: Create a shell user-t, --token <token>: API token-s, --shell <shell>: Shell (default: /bin/bash)-g, --group <group>: Group (default: sudo)-k, --public-keys <keys>: Public key IDs (comma-separated)--json,--csv
delete <slug> <id>: Delete a shell user-t, --token <token>: API token-f, --force: Force deletion--wait: Wait for completion
update <slug> <id>: Update a shell user's public keys-t, --token <token>: API token-k, --public-keys <keys>: Public key IDs (comma-separated)--json,--csv
webssh-token <serverSlug> <username>: Generate a WebSSH token for a shell user-t, --token <token>: API token--json: Output as JSON
Manage server snapshots.
list <serverSlug>: List all snapshots for a server-t, --token <token>: API token--json,--csv
create <serverSlug> <name>: Create a snapshot for a server-t, --token <token>: API token--json,--csv--wait: Wait for completion
delete <serverSlug> <snapshotId>: Delete a snapshot-t, --token <token>: API token--wait: Wait for completion
restore <serverSlug> <snapshotId>: Restore a server from a snapshot-t, --token <token>: API token--wait: Wait for completion
Manage SSH keys.
list: List all SSH keys-t, --token <token>: API token--json,--csv
create <name> <key>: Add a new SSH key-t, --token <token>: API token--json,--csv
delete <id>: Delete an SSH key-t, --token <token>: API token
Contributions are welcome! Please feel free to submit a pull request or open an issue to report a bug or suggest a new feature.
