MEGAcmd Documentation

MEGAcmd provides the following capabilities:

• File Management: Move files between your local PC and your MEGA account via CLI.
• Automation: Use commands in scripts for file management.
• Synchronization & Backup: Set up scheduled syncs or backups between local folders and MEGA using sync or backup commands.
• WebDAV: Access your MEGA files via WebDAV using the webdav command.
• FUSE Mount (Linux only): Mount your MEGA cloud folder to your local filesystem using the fuse-add command.

A session is created when you log in with your email and password. Sessions persist until you log out or kill them.

• View active sessions: Use whoami -l to see all open sessions across all devices.
• Terminate a session: Use killsession to close a session.

Warning: Killing a session immediately closes the connection for the device using it. Since sync, backup, and WebDAV configurations are tied to a session, logging out will cancel these active processes.

MEGAcmd supports pattern matching via several methods depending on how it was compiled:

1. PCRE (Perl Compatible Regular Expressions): If compiled with PCRE (enabled by default), use the --use-pcre flag with commands like find.
2. C++11: If PCRE is not available, C++11 regular expressions are used.
3. Wildcards: If neither of the above is available, you can only use standard wildcards:
   • *: Matches any number of characters.
   • ?: Matches a single unknown character.

Important for Non-interactive mode: When using patterns in a standard shell, you must escape shell symbols (e.g., \*) or wrap the pattern in quotes (e.g., "*.txt") to prevent the shell from expanding them before they reach MEGAcmd.

MEGAcmd logs are divided into two distinct categories, each with its own log level. You can adjust these levels using the log command.

Log Categories

• cmd: Messages reported by MEGAcmd itself regarding user command processing.
• sdk: Messages reported by the SDK and dependent libraries regarding requests, transfers, network, etc.

Log Levels

Levels range from FATAL (lowest) to VERBOSE (highest). Each log message is prefixed with its category (cmd or sdk) and its level (e.g., DBG, INFO, DTL).

Example log format: 2025-02-07_16-47-56.662269 cmd DBG Registering state listener...

MEGAcmd can be used in two primary ways:

1. Interactive Mode: Running the mega-cmd shell where you type commands directly into a command-line interface.
2. Scriptable Mode: Running commands directly from your system shell (e.g., bash, zsh, cmd.exe). To do this, prefix any command with mega-. For example, if the interactive command is ls, the scriptable version is mega-ls.

Key Terminology:

• Remote Path: Refers to a file or folder located in your MEGA cloud account online.
• Local Path: Refers to a file or folder on your local device where MEGAcmd is running.
• Verbosity: You can increase the amount of information returned by any command by passing -v (e.g., -vv, -vvv).

When inspecting synchronizations, the output includes two key state indicators: RUN_STATE and STATUS.

RUN_STATE (Execution Lifecycle):

• Pending: Sync config loaded, but the sync has not yet attempted to start.
• Loading: Sync is currently loading from disk.
• Running: Sync is loaded and active.
• Suspended: Sync is not loaded, but exists on disk with its last known state.
• Disabled: Sync has been disabled; starting it will behave like a brand new configuration.

STATUS (Transfer State):

• NONE: Status is unknown.
• Synced: No transfers or pending actions are ongoing.
• Pending: The sync engine is performing calculations.
• Syncing: Transfers or pending actions are currently being carried out.
• Processing: State cannot be determined (the engine is too busy; try again later).
• ERROR: Indicates an error occurred (check the ERROR column for details).

MEGAcmd distinguishes between official attributes and custom attributes. Custom attributes are internally stored with a _ prefix.

If you want to show, modify, or delete a custom attribute that shares the same name as an official attribute, you must use the --force-non-official flag. This allows you to bypass the official attribute name and interact with the version prefixed with _.

MEGAcmd can be used in two primary ways:

1. Interactive Mode: The shell processes commands directly as you type them.
2. Scriptable Mode: Commands are run from a system shell (like bash on Linux/macOS or Command Prompt on Windows), allowing them to be used in automation scripts.

To enable features like synchronization and backup, MEGAcmd runs a background server process. This process forwards requests from the shell or scripts.

• To close the interactive shell but keep the background server running (to maintain sync/backup), use: quit --only-shell.
• To close everything, use: quit.

Use the following commands to view and control your active FUSE mounts:

List all mounts

To see a summary of all existing mounts (including name, local path, remote path, persistence, and enabled status), use:

$ fuse-show

To get detailed information about a specific mount, provide its name or local path:

$ fuse-show <NAME|LOCAL_PATH>

Enable or disable a mount

To make cloud files accessible locally or to stop exposing them, use fuse-enable or fuse-disable:

$ fuse-enable <NAME|LOCAL_PATH>
$ fuse-disable <NAME|LOCAL_PATH>

Note: Disabled mounts still exist and will appear in fuse-show results.

Remove a mount

To permanently delete a mount configuration, use fuse-remove. Requirement: You must disable the mount using fuse-disable before it can be removed.

$ fuse-remove <NAME|LOCAL_PATH>