Files
2026-07-13 13:39:12 +08:00

3.8 KiB

name, description
name description
cli-backup-sync Backup and restore OmniRoute data from the CLI. Trigger incremental snapshots, sync to cloud storage, manage backup schedules, and restore from archive files.

Overview

Backup and restore OmniRoute data from the CLI. Trigger incremental snapshots, sync to cloud storage, manage backup schedules, and restore from archive files.

Quick install

npm install -g omniroute   # or: npx omniroute
omniroute --version

Subcommands

backup

Example:

omniroute backup

backup create

Flags:

  • --name <name>
  • --cloud
  • --encrypt
  • --key-file <path>
  • --exclude <pattern>
  • --retention <n>

Example:

omniroute backup create

backup auto

Example:

omniroute backup auto

backup enable

Flags:

  • --cron <expr>
  • --cloud
  • --encrypt
  • --retention <n>

Example:

omniroute backup enable

backup disable

Example:

omniroute backup disable

backup status

Flags:

  • --name <name>
  • --cloud
  • --encrypt
  • --key-file <path>
  • --exclude <pattern>
  • --retention <n>

Example:

omniroute backup status

backup restore [backupId]

Flags:

  • --list
  • --yes

Example:

omniroute backup restore [backupId]

task

Example:

omniroute task

cloud create

Flags:

  • --title <t>
  • --prompt <p>
  • --prompt-file <path>
  • --repo <url>
  • --branch <b>
  • --metadata <json>

Example:

omniroute cloud create

cloud list

Flags:

  • --status <s>
  • --limit <n>

Example:

omniroute cloud list

cloud get <taskId>

Example:

omniroute cloud get <taskId>

cloud status <taskId>

Example:

omniroute cloud status <taskId>

cloud cancel <taskId>

Flags:

  • --yes

Example:

omniroute cloud cancel <taskId>

cloud approve <taskId>

Example:

omniroute cloud approve <taskId>

cloud message <taskId> <message>

Example:

omniroute cloud message <taskId> <message>

cloud sources <taskId>

Example:

omniroute cloud sources <taskId>

cloud cloud

Example:

omniroute cloud cloud

cloud agents

Example:

omniroute cloud agents

cloud auth

Flags:

  • --no-browser
  • --timeout <ms>

Example:

omniroute cloud auth

sync

Example:

omniroute sync

sync push

Flags:

  • --target <t>
  • --bundle <list>
  • --dry-run

Example:

omniroute sync push

sync pull

Flags:

  • --source <s>
  • --merge
  • --replace
  • --dry-run

Example:

omniroute sync pull

sync diff

Flags:

  • --source <s>
  • --target <t>

Example:

omniroute sync diff

sync bundle <outPath>

Flags:

  • --include <list>

Example:

omniroute sync bundle <outPath>

sync import <bundlePath>

Flags:

  • --dry-run

Example:

omniroute sync import <bundlePath>

sync initialize

Flags:

  • --from-cloud

Example:

omniroute sync initialize

sync tokens

Example:

omniroute sync tokens

sync list

Example:

omniroute sync list

sync create

Flags:

  • --name <n>
  • --scope <s>
  • --ttl <duration>

Example:

omniroute sync create

sync revoke <id>

Flags:

  • --yes

Example:

omniroute sync revoke <id>

sync status

Example:

omniroute sync status

sync resolve

Example:

omniroute sync resolve