Category:Canasta CLI

Guides

Getting started

Configuration

Operations

Development

CLI Reference

canasta — A CLI tool for Canasta installations.
- add — Add a new wiki to a Canasta instance
- backup — Backup and restore Canasta installations
  - check — Check backup repository integrity
  - create — Create a backup
  - delete — Delete a backup
  - diff — Show difference between two backups
  - files — List files in a backup
  - init — Initialize a backup repository
  - list — List backups
  - purge — Remove old backups based on retention policy
  - restore — Restore a backup
  - schedule — Manage scheduled backups
    - list — Show the backup schedule
    - remove — Remove a scheduled backup
    - set — Set a recurring backup schedule
  - unlock — Remove locks other processes created
- config — View and modify Canasta configuration
  - get — Show configuration settings
  - set — Change a configuration setting
  - unset — Remove a configuration setting
- create — Create a Canasta installation
- delete — Delete a Canasta installation
- devmode — Manage development mode
  - disable — Disable development mode
  - enable — Enable development mode
- export — Export the database of a wiki in a Canasta instance
- extension — Manage Canasta extensions
  - disable — Disable a Canasta extension
  - enable — Enable a Canasta extension
  - list — Lists all the installed Canasta extensions
- gitops — Git-based configuration management
  - add — Stage files for the next gitops push
  - diff — Show what would change on pull (dry run)
  - init — Bootstrap a new gitops repository from an existing installation
  - join — Join an existing gitops repository
  - pull — Pull latest configuration from the git repository
  - push — Push configuration changes to the git repository
  - rm — Remove files from the gitops repository
  - status — Show gitops status for the installation
- import — Import a database into an existing wiki
- list — List all Canasta installations
- maintenance — Use to run update and other maintenance scripts
  - exec — Execute a command in a running container
  - extension — Run extension maintenance scripts
  - script — Run maintenance scripts
  - update — Run maintenance update jobs
- remove — Remove a wiki from a Canasta instance
- restart — Restart the Canasta installation
- sitemap — Manage sitemaps for a Canasta instance
  - generate — Generate sitemaps for one or all wikis
  - remove — Remove sitemaps for one or all wikis
- skin — Manage Canasta skins
  - disable — Disable a Canasta skin
  - enable — Enable a Canasta skin
  - list — Lists all the installed Canasta skins
- start — Start the Canasta installation
- stop — Shuts down the Canasta installation
- upgrade — Upgrade the Canasta CLI and all registered installations
- version — Show the Canasta version

Pages in category "Canasta CLI"

This category contains only the following page.

G

Help:Quick start