Skip to content

CLI Reference

smallweb

Host websites from your internet folder

smallweb [flags]

Options

      --dir string      The root directory for smallweb
      --domain string   The domain for smallweb
  -h, --help            help for smallweb

smallweb config

Open Smallweb configuration

smallweb config [flags]

Options

  -h, --help   help for config
      --json   Output the configuration in JSON format

Options inherited from parent commands

      --dir string      The root directory for smallweb
      --domain string   The domain for smallweb

smallweb crons

List cron jobs

smallweb crons [app] [flags]

Options

  -a, --app string   filter by app name
  -h, --help         help for crons
      --json         output as json

Options inherited from parent commands

      --dir string      The root directory for smallweb
      --domain string   The domain for smallweb

smallweb doctor

Check the system for potential problems

smallweb doctor [flags]

Options

  -h, --help   help for doctor

Options inherited from parent commands

      --dir string      The root directory for smallweb
      --domain string   The domain for smallweb

smallweb init

Initialize a new workspace

smallweb init <domain> [flags]

Options

  -h, --help   help for init

Options inherited from parent commands

      --dir string      The root directory for smallweb
      --domain string   The domain for smallweb

smallweb list

List all smallweb apps

smallweb list [flags]

Options

      --admin   filter by admin
  -h, --help    help for list
      --json    output as json

Options inherited from parent commands

      --dir string      The root directory for smallweb
      --domain string   The domain for smallweb

smallweb run

Run an app cli

smallweb run <app> [args...] [flags]

Options

  -h, --help   help for run

Options inherited from parent commands

      --dir string      The root directory for smallweb
      --domain string   The domain for smallweb

smallweb up

Start the smallweb evaluation server

smallweb up [flags]

Options

      --addr string              address to listen on
      --enable-crons             enable cron jobs
  -h, --help                     help for up
      --log-format string        log format (json, text or pretty)
      --log-output string        log output (stdout, stderr or filepath) (default "stderr")
      --on-demand-tls            enable on-demand tls
      --smtp-addr string         address to listen on for smtp
      --ssh-addr string          address to listen on for ssh/sftp
      --ssh-host-key string      ssh host key
      --ssh-private-key string   ssh private key
      --tls-cert string          tls certificate file
      --tls-key string           tls key file

Options inherited from parent commands

      --dir string      The root directory for smallweb
      --domain string   The domain for smallweb