Cloudron Commandline Tool
The Cloudron CLI tool allows you to install, configure and test apps on your Cloudron.
It is also used to submit your app to the Cloudron Store. The
machine subcommand can be used for
various maintenance tasks on a selfhosted Cloudron.
Read the Cloudron.io documentation for in-depth information.
npm install -g cloudron
Depending on your setup, you may need to run this as root.
You should now be able to run the
cloudron help command in a shell.
completion Shows completion for you shellbackup [options] Create backupbuild [options] Build an appclone [options] Clone an existing app to a new locationcreateOAuthAppCredentials [options] Create oauth app credentials for local developmentdownload-backup <id> [outdir] Download backupexec [options] [cmd...] Exec a command in applicationinspect [options] Inspect a Cloudron returning raw JSONinit Creates a new CloudronManifest.json and Dockerfileinstall [options] Install or update app into cloudronlist List installed applicationslist-backups [options] List app backupslogin [options] [cloudron] Login to cloudronlogout Logout off cloudronlogs [options] Application logsmachine Cloudron instance toolingopen Open the app in the Browserpublished [options] List published appspull [options] <remote> <local> pull remote file/dir. Use trailing slash to indicate remote directory.push [options] <local> <remote> push local filerestore [options] Restore app from last known backuprestart [options] Restart the installed applicationstatus [options] Application infosubmit Submit app to the store for reviewupload [options] Upload app to the store for testingversions [options] List published versionsuninstall [options] Uninstall app from cloudronunpublish [options] Unpublish app or app version from the store
To add tab completion to your shell, the cloudron tool can generate it on the fly for the shell you are using. Currently tested on
Just run the following in your shell
. <(cloudron completion)
This command loads the completions into your current shell. Adding it to your ~/.bashrc or ~/.zshrc will make the completions available everywhere.
The tests can run against a Cloudron as follows:
CLOUDRON=<domain> USERNAME=<username> PASSWORD=<password> mocha tests/