Skip to content

Command Line Interface

Here are the most common commands you can use in RKD ROCKETDOO.

You can use either rocketdoo or the shorter alias rkd — both are equivalent.

TIP: Combine any command with --help to see its flags and options.
Example: rkd build --help

General

  • Display Rocketdoo version:
rkd --version
  • Display help and available commands:
rkd --help

Project Setup

  • Generate the directory and file structure:
rkd scaffold
  • Launch the initialization wizard:
rkd init
  • Display detailed information about the current project:
rkd info

Container Management

  • Deploy Odoo (start containers in detached mode):
rkd up -d
  • Check the status of your containers:
rkd status
  • Stop all containers:
rkd stop
  • Restart the containers:
rkd restart
  • Remove containers:
rkd down
  • Remove containers and their associated volumes:
rkd down -v
  • Force environment rebuild:
rkd build
  • Build and restart containers in one step:
rkd build --rebuild
  • View container logs:
rkd logs
  • Follow logs in real-time for a specific container:
rkd logs <container_name> -f

Environment Sharing

  • Package your entire environment to share with other developers:
rkd pack
  • Unpackage a shared .zip project into your directory:
rkd unpack

Utilities

  • Delete .Identifier files generated by WSL2 when copying files from Windows:
rkd del -i
  • Preview which files would be deleted (dry run, no files removed):
rkd del -i --dry-run
  • Bulk update module packages loaded as public repositories using Gitman:
    (This command must be executed inside the container.)
gitman update

📧 Mail — Mailpit Email Testing (rkd mail)

Mailpit is a local SMTP server and web UI that captures all outgoing emails from Odoo instead of actually sending them. Ideal for testing email workflows without affecting real users.

  • Enable Mailpit (start service + configure Odoo SMTP automatically):
rkd mail on
  • Disable Mailpit and restore default SMTP settings:
rkd mail off
  • Check the current Mailpit status:
rkd mail status
  • Open the Mailpit web interface in the browser:
rkd mail open

Mailpit web UI is available at http://localhost:8025 when active.

🌐 Traefik Reverse Proxy (rkd traefik)

Traefik allows you to expose your local Odoo instance using a custom domain, both for local development (HTTP) and production environments (HTTPS with Let's Encrypt).

  • Enable Traefik for this project (interactive wizard — prompts for domain and mode):
rkd traefik on
  • Enable with specific options:
rkd traefik on --domain myproject.local --mode local
rkd traefik on --domain myproject.com --mode production
  • Disable Traefik for this project (restores direct port access):
rkd traefik off
  • Show Traefik integration status:
rkd traefik status
  • Show step-by-step guide to configure local domains (/etc/hosts and WSL2):
rkd traefik guide

Traefik modes: - local — HTTP only, custom domain via /etc/hosts. - production — HTTPS with automatic Let's Encrypt certificate.

🚀 VPS Instance Deployment (rkd instance)

The instance command deploys a complete Odoo instance to a VPS. It supports two deployment types:

  • docker — transfers Dockerfile + compose files and builds on the VPS.

  • native — installs Odoo via official apt packages on the server.

  • Configure stage/production environments interactively (saves to .rkd/instance.yaml):

rkd instance init
  • Overwrite an existing configuration:
rkd instance init --force
  • Deploy to the staging environment:
rkd instance deploy --env stage
  • Deploy to production (with confirmation prompt):
rkd instance deploy --env prod
  • Deploy to production skipping the confirmation:
rkd instance deploy --env prod --yes
  • Preview generated files without deploying (dry run):
rkd instance deploy --env prod --dry-run
  • Show status of all configured deployment targets:
rkd instance status

🖥️ Graphical User Interface (rkd gui)

Launch the Rocketdoo web GUI in your browser. Provides full container management, live logs, mail, deploy, and more — all without typing commands.

  • Start the GUI on the default port (8070):
rkd gui
  • Start the GUI on a custom port:
rkd gui --port 9090
  • Start the GUI and open the browser automatically:
rkd gui --open
  • Start the GUI for a project in a specific directory:
rkd gui --cwd /path/to/project

The GUI is available at http://localhost:8070 by default. Press Ctrl+C to stop it.

Learn more about the GUI