Canasta CLI (command-line interface) tool

This is the official command line interface tool for the Canasta MediaWiki distribution.

Supported platforms

Canasta CLI supports the following platforms:

• Linux: AMD64/x86-64 and ARM64/AArch64
• macOS: Intel (AMD64/x86-64) and Apple Silicon (ARM64/AArch64)

Windows Users: Please use WSL (Windows Subsystem for Linux) and install the Linux version. Docker Desktop on Windows already uses WSL2, so this provides the best compatibility.

Commands

create

Description: Creates a Canasta installation. Enhanced to support wiki farm setup with the -f flag.

Usage: canasta create [flags]

• -p, --path: Canasta directory.
• -o, --orchestrator: Orchestrator to use for installation (default: "compose").
• -i, --id: Canasta instance ID.
• -w, --wiki: ID of the wiki.
• -t, --site-name: Display name of the wiki (optional, defaults to wiki ID).
• -n, --domain-name: Domain name (default: "localhost").
• -a, --admin: Initial wiki admin username (required).
• -s, --password: Initial wiki admin password (if not provided, auto-generates and saves to config/admin-password_{wikiid}).
• -f, --yamlfile: Initial wiki yaml file for wiki farm setup.
• -k, --keep-config: Keep the config files on installation failure.
• -r, --override: Name of a file to copy to docker-compose.override.yml.
• -e, --envfile: Path to .env file with password overrides (merged with default .env).
• --rootdbpass: Root database password (if not provided, auto-generates and saves to .env).
• --wikidbuser: The username of the wiki database user (default: "root").
• --wikidbpass: Wiki database password (if not provided, auto-generates and saves to .env).

YAML Format for Wiki Farm: To create a wiki farm, you first need to create a YAML file with the following format:

wikis:
  - id: [WIKI_ID] # Example: "mywiki1"
    url: [WIKI_URL] # Example: "mywiki1.example.com"

Then run the following:

canasta create -f [yamlfile] # Example: "wikis.yaml"

extension

Description: Manage Canasta extensions. Enhanced to target a specific wiki within the farm using the -w flag.

Subcommands:

• list: Lists all the installed Canasta extensions.
• enable: Enables specified extensions.
• disable: Disables specified extensions.

Usage:

canasta extension [subcommand] [flags]

Flags:

• -i, --id: Specifies the Canasta instance ID.
• -p, --path: Specifies the Canasta installation directory.
• -w, --wiki: Specifies the ID of a specific wiki within the Canasta farm.
• -v, --verbose: Enables verbose output.

add

Description: Adds a new wiki to a Canasta instance.

Usage:

canasta add [flags]

Flags:

• -w, --wiki: ID of the new wiki (required).
• -u, --url: URL of the new wiki in domain/path format (e.g., 'localhost/wiki2' or 'example.com/mywiki'; required).
• -t, --site-name: Display name of the wiki (optional, defaults to wiki ID).
• -p, --path: Path to the new wiki.
• -i, --id: Canasta instance ID (required).
• -o, --orchestrator: Orchestrator to use for installation (default: "compose").
• -d, --database: Path to the existing database dump.
• -a, --admin: Admin name of the new wiki (required).
• -s, --password: Admin password for the new wiki (if not provided, auto-generates and saves to config/admin-password_{wikiid}).
• --wikidbuser: The username of the wiki database user (default: "root").

remove

Description: Removes a wiki from a Canasta instance.

Usage:

canasta remove [flags]

Flags:

• -w, --wiki: ID of the wiki to be removed.
• -p, --path: Path to the wiki.
• -i, --id: Canasta instance ID.