********************************* Command Line Interface Cheatsheet ********************************* ============================= Application Specific Commands ============================= --------------------- Managing Applications --------------------- ========================= ======================================================================== ``robin app create`` Creates an app from a ROBIN template, K8S selectors, snapshot or backup ``robin app delete`` Deletes an app ``robin app attach`` Attaches an external storage repo (S3, GCS, ...) to an app ``robin app detach`` Detaches a previously attached repo ``robin app clone`` Clones an app from its snapshot ``robin app list`` Lists all applications ``robin app info`` Provides detailed information about an appr ``robin app register`` Register any generic Kubernetes App or Operator with ROBIN ``robin app config`` Configure various attributes/schedules of an app ``robin app restore`` Restore an application snapshot that was deleted locally ``robin app rollback`` Rollback an application to a snapshot ========================= ======================================================================== ------------------------------ Managing Application Snapshots ------------------------------ =========================== ======================================================================== ``robin snapshot create`` Takes a snapshot of an application ``robin snapshot delete`` Deletes one or more snapshots of an application ``robin snapshot info`` Shows detailed information about a specific snapshot ``robin snapshot list`` Lists snapshots for one or more applications ``robin snapshot push`` Pushes snapshot to a repository (repo) attached to the application ``robin snapshot pull`` Pulls a previously pushed snapshot from a repository (repo) =========================== ======================================================================== -------------------------------------- Managing External Storage Repositories -------------------------------------- =========================== ======================================================================== ``robin repo register`` Register a new external storage repository (S3, GCS, ...) ``robin repo unregister`` Deletes a repo ``robin repo list`` Lists all repos ``robin repo info`` Show details about a specific repo ``robin repo contents`` Show the contents of a repo ``robin repo attach`` Attach a repo to a specific app ``robin repo detach`` Detach a repo from a specific app ``robin repo purge`` Purge/delete entries in a repo ``robin repo status`` Show status of transfers to and from repo ``robin repo share`` Share a repo with one or more users ``robin repo unshare`` Stop sharing a repo with one or more users =========================== ======================================================================== ---------------------------- Managing Application Backups ---------------------------- =========================== ======================================================================== ``robin backup create`` Backup an application snapshot to repository ``robin backup delete`` Delete backup of an application snapshot ``robin backup list`` List all backups of an application ``robin backup info`` Show information about a specific backup ``robin backup status`` Show transfer status of backup to repository ``robin backup share`` Share a backup with one or more users ``robin backup unshare`` Stop sharing a backup with one or more users ``robin backup export`` Generate a token for use when importing an application backup into another cluster ``robin backup import`` Import an application backup from another cluster =========================== ======================================================================== ================================ Infrastructure Specific Commands ================================ -------------- Managing Users -------------- =============================== ======================================================================== ``robin login`` Log a user into the ROBIN cluster ``robin password change`` Change the password for the current ROBIN user ``robin user add`` Add a new user to the ROBIN cluster ``robin user list`` List ROBIN cluster users ``robin user update`` Update a user ``robin user remove`` Remove a user from the ROBIN cluster ``robin user change-namespace`` Change the current namespace for a ROBIN user =============================== ======================================================================== -------------- Managing Hosts -------------- =========================== ========================================================================================== ``robin host list`` List all the hosts registered with the ROBIN cluster along with basic information ``robin host info`` Show detailed information about a specific host ``robin host probe`` Rediscover host configuration including their state, drives attached, memory available etc. =========================== ========================================================================================== ---------------------- Managing Storage Disks ---------------------- ====================== ======================================================================== ``robin disk create`` Create a Cloud Disk (only for AWS, Azure, and GCP) ``robin disk list`` List all disks in the ROBIN cluster ``robin disk info`` Show information about a specific disk ``robin disk attach`` Attach a disk to a specific ROBIN node ``robin disk detach`` Detach a disk from a specific ROBIN node ``robin disk addtag`` Add tags to a disk ``robin disk deltag`` Remove tags from disk ====================== ======================================================================== ---------------------- Managing Volumes ---------------------- ====================== ======================================================================== ``robin volume list`` List all storage volumes in the ROBIN cluster ``robin volume info`` Show information about a specific storage volume ====================== ========================================================================