Skip to main content

Usage

Welcome to Filen CLI v0.2.8!

You can find out more about the Filen CLI at https://github.com/FilenCloudDienste/filen-cli-releases

Invoke the Filen CLI with no command specified to enter interactive mode (REPL). There, you can specify absolute paths (starting with "/") or relative paths (supports "." and "..").

Options​

  • -v, --verbose...
    Increase verbosity (-v, -vv, -vvv)
  • -q, --quiet
    Hide progress bars and other non-essential output (overrides -v)
  • --config-dir <CONFIG_DIR>
    Config directory (overrides system default)
  • -e, --email <EMAIL>
    Filen account email (requires --password) [env: FILEN_CLI_EMAIL=]
  • -p, --password <PASSWORD>
    Filen account password (requires --email) [env: FILEN_CLI_PASSWORD=]
  • -t, --two-factor-code <TWO_FACTOR_CODE>
    Filen account two-factor code (optional, requires --email and --password) [env: FILEN_CLI_2FA_CODE=]
  • --auth-config-path <AUTH_CONFIG_PATH>
    Path to auth config file (exported via filen export-auth-config)
  • --concurrency <CONCURRENCY>
    Limit concurrent API connections
  • --requests-per-sec <REQUESTS_PER_SEC>
    Maximum number of API requests per second
  • --upload-bandwidth-kbps <UPLOAD_BANDWIDTH_KBPS>
    Cap upload bandwidth, in kilobytes per second
  • --download-bandwidth-kbps <DOWNLOAD_BANDWIDTH_KBPS>
    Cap download bandwidth, in kilobytes per second
  • --memory-budget-bytes <MEMORY_BUDGET_BYTES>
    Memory budget for file I/O, in bytes
  • --connect-timeout <CONNECT_TIMEOUT>
    Connection timeout
  • --skip-update
    Skip checking for updates
  • --force-update-check
    Force checking for updates
  • --always-update
    Force checking for updates and install them automatically. Usually, updates are only installed in REPL mode
  • --reluctant-autocomplete
    Sets autocomplete to be less eager, only completing remote paths after pressing tab
  • --json
    Format command output as machine-readable JSON (where applicable)
  • --working-path <WORKING_PATH>
    The initial working path for the REPL or non-interactive commands (defaults to "/")
  • -V, --version
    Print version

Updates​

The updater checks for new releases from https://github.com/FilenCloudDienste/filen-cli-releases when the CLI is run (unless skipped in the 5mins since the last check, or through the --skip-update flag). The executable will be replaced in place, with the filename updated if it contains the version number.

Commands​

help [COMMAND_OR_TOPIC]
Print help about a command or topic (default: general help)
🠊 [COMMAND_OR_TOPIC] Command or topic to show help about

view-html-docs
View the documentation (same as --help) locally in a browser rendered as HTML

exit
Exit the REPL