This document relates to MEGAcmd version 0.9.9. It contains introductory information and the Command Summary, with links to detailed command descriptions.
A command line tool to work with your MEGA account and files. The intent is to offer all the MEGA account functionality via command line. You can run it in interactive mode where it processes all commands directly, or you can run its scriptable commands from your favourite Linux or Mac shell such as bash, or you can even run its commands in a Windows command prompt. And of course you can write scripts using those scriptable commands.
Here is an example of downloading a file using MEGAcmd. In this case we are downloading a file specified by a public link, which does not require being logged in:
mega-get https://mega.nz/#F!ABcD1E2F!gHiJ23k-LMno45PqrSTUvw /path/to/local/folder
Note:- If you get any error like this one
Event not found
In link put \ in front of every ! for example
mega-get https://mega.nz/#F\!ABcD1E2F\!gHiJ23k-LMno45PqrSTUvw /path/to/local/folder
And here is an example of uploading a file using MEGAcmd, and making a link available to share it, that will expire after 10 minutes.
mega-put /path/to/my/temporary_resource /exportedstuff/
mega-export -a /exportedstuff/temporary_resource --expire=10M | awk '{print $4}'
And here is an example of the power of using scriptable MEGAcmd commands in bash. In this case we are going to share some promotional videos previously uploaded to MEGA:
for i in $(mega-find /enterprise/video/promotional2015/may --pattern="*mpeg")
do
mega-export -a $i | awk '{print $4}';
done
In addition to running commands on request, MEGAcmd can also be configured to synchronise folders between your local device and your MEGA account, or perform regular backups from your device to your MEGA account.
In order to enable synchronisation and backup features, and for efficiency running commands, MEGAcmd runs a server process in the background which the MEGAcmd shell or the script commands forward requests to. The server keeps running in the background until it is told to close with the quit command. If you want it to keep running when you quit the interactive shell (to keep sync and backup runnign for example), use quit --only-shell.
Working with your MEGA account requires signing in with your email and password using the login command, though you can download public links or upload to public folders without logging in. Logging in with your username and password starts a Session, and causes some of your account such as the folder structure to be downloaded to your Local Cache.
For Linux, Mac, or Windows: Download it from the MEGA.nz website: https://mega.nz/cmd
We are also building it for some NAS systems, please check your provider's App Store.
The major features are
- Move files around inside your MEGA account or between MEGA and your PC using command line tools.
- Use those same commands in scripts to manage your files.
- Set up synchronization or a backup schedule between a folder on your machine, and a folder on your MEGA account. (use the
syncorbackupcommands) - Set up WebDAV access to files in your MEGA account (use the
webdavcommand)
See our Help Centre pages for the basics of getting started, and friendly examples of common usages with plenty of pictures: https://mega.nz/help
Interactive refers to running the MEGAcmd shell which only processes MEGA commands. You invoke commands by typing and pressing Enter. MEGAcmd shell provides a lot of feedback about what it's doing. You can start the MEGAcmd shell with mega-cmd (or MEGAcmd on Windows). You can then issue commands like ls directly:
ls /my/account/folder
or you can get a list of available commands with:
help
or you can get detailed information about any particular command by using the --help flag with that command:
ls --help
Autocompletion (pressing tab to fill in the remainder of a command) is available in interactive mode.
Scriptable refers to running the MEGAcmd commands from a shell such as bash or the windows powershell. If the PATH to the MEGAcmd commands are not yet on the PATH in that shell, you'll need to add it. You can then issue commands like ls by prefixing them with the mega- prefix:
mega-ls /my/account/folder
or you can get a list of available commands with:
mega-help
or you can get detailed information about any particular command by using the --help flag with that command:
mega-ls --help
Scriptable commands can of course be used in scripts to achieve a lot in a short space of time, using loops or preparing all the desired commands ahead of time. If you are using bash as your shell, the MEGAcmd commands support auto-completion.
A contact is someone (identified by their email address) that also has a MEGA account, who you can share files or folders with, and can chat with on MEGAchat.
This refers to a file or a folder stored in your MEGA account, or a publicly available file or folder in the MEGA cloud. Remote paths always use the '/' character as the separator between folder and file elements.
Some MEGAcmd commands allow the use of regular expressions in remote paths. You can check if the command supports those by using the --help flag with the command. If you use these in the scriptable way, you need to escape characters that would otherwise be intercepted and interpreted by the shell.
Paths to folders shared to you from another person start with their email and a : character, see the example at (example)
This refers to a file or folder on the PC or device that MEGAcmd is running in.
When you log in with your email and MEGA account password, that creates a session. The session exists until you log out of it or kill it from another client. In MEGAcmd, use whoami -l to see all your open sessions across all devices, and use killsession to close them. You can use other MEGA clients such as the phone app, or webclient to close these also. Devices that were using a killed session will have their connection to MEGA closed immediately and will no longer have access to your account, until you log in on them again. Syncs, backups, and webdavs are specific to a session, so logging out will cause them to be cancelled.
Logging in with MEGAcmd creates your Local Cache, a subfolder of your home folder. MEGAcmd downloads and stores some data in your Local Cache relating to your account, such as folder structure and contacts, for performance reasons. The MEGAcmd background server keeps the local cache up to date when changes to your account occur from other clients. The cache does contain a way for MEGAcmd to access your MEGA account when it starts up again if you have not specifically logged out. The Local Cache also contains information from your Session, including sync, backup, and webdav configurations. Logging out cleans the Local Cache, but also closes your session and the sync, backup, and webdav configurations are wiped.
MEGAcmd can set up a synchronisation between a folder on your local machine and a folder in your MEGA account, using the sync command. This is the same mechanism that MEGAsync uses. The synchronisation is two-way: the folders you nominate to be synced will mirror any action! Whatever you add or delete in your sync folder on your device gets added or deleted in your sync folder in your MEGA account. And additions or deletions in your synced folder in your MEGA account will similarly be applied to your local synced folder. Files that are removed from sync folders are moved to a hidden local folder (Rubbish/.debris inside your local sync folder, or SyncDebris folder in the Rubbish Bin of your MEGA account).
Here is a very simple example of setting up a synchronisation with MEGAcmd:
sync /path/to/local/folder /folder/in/mega
You can set up more than one pair or folders to be synced, and you can also set a sync from another device to the same folder, to achieve folder synchronisations between different devices. The changes are sent via your MEGA account rather than directly between the devices in that case.
Additional information about synchronising folders is available in our Help Centre: https://mega.nz/help/client/megasync/syncing
MEGAcmd can set up a periodic copy of a local folder to your MEGA account using the backup command. Here is a simple example that will back up a folder immediately and then at 4am each day, keeping the 10 most recent backups:
backup /path/mega/folder /remote/path --period="0 0 4 * * *" --num-backups=10
For further information on backups, please see the backup command and the tutorial.
MEGAcmd can set up access to folders or files in your MEGA account as if they were local folders and files on your device using the webdav command. For example making the folder appear like a local drive on your PC, or providing a hyperlink a browser can access, where the hyperlink is to your PC.
For further information on WebDAV, please see the webdav command and the tutorial.
On Linux, MEGAcmd commands are installed at /usr/bin and so will already be on your PATH. The interactive shell is mega-cmd and the background server is mega-cmd-server, which will be automatically started on demand. The various scriptable commands are installed at the same location, and invoke mega-exec to send the command to mega-cmd-server.
If you are using the scriptable commands in bash (or using the interactive commands in mega-cmd), the commands will auto-complete.
For MacOS, after installing the dmg, you can launch the server using MEGAcmd in Applications. If you wish to use the client commands from MacOS Terminal, open the Terminal and include the installation folder in the PATH.
Typically:
export PATH=/Applications/MEGAcmd.app/Contents/MacOS:$PATH
And for bash completion, source megacmd_completion.sh :
source /Applications/MEGAcmd.app/Contents/MacOS/megacmd_completion.sh
Once you have MEGAcmd installed, you can start the interactive shell from the Start Menu or desktop icon. On windows the interactive shell executable is called MEGAcmdShell.exe and the server is MEGAcmdServer.exe.
On Windows 7, we recommend using the MEGAcmd shell from inside PowerShell for a better user experience (and you can do this on other Windows platforms also). You can start powershell from the Start Menu and then execute these commands to start it:
$env:PATH += ";$env:LOCALAPPDATA\MEGAcmd"
MEGAcmdShell
For scriptable usage, the MEGAcmd commands are provided via installed .bat files which pass the command to the MEGAcmdServer.exe. Provided you have set the PATH as above, you can use these like normal command line tools in PowerShell:
$env:PATH += ";$env:LOCALAPPDATA\MEGAcmd"
mega-cd /my/favourite/folder
mega-ls
Or in Command Prompt:
set PATH=%LOCALAPPDATA%\MEGAcmd;%PATH%
mega-cd /my/favourite/folder
mega-ls
And of course those can be invoked in your own .bat or .cmd files. Autocompletion is not available for the scriptable commands, but is in the interactive shell.
Unicode is supported though it currently in the interactive shell it needs to be switched on, and to have a suitable font selected; please execute help --unicode for the latest information. There are plans to improve this. Please report any issues experienced to our support team.
We have released packages for QNAP and Synology, which you can download and install from the App Center in QNAP, and the Package Center in Synology. In QNAP, please make sure to turn on "Enable home folder for all users" from the control panel, and set HOME=/share/homes/ before starting any MEGA commands, and in Synology, 'Enable user home service', so that the mega-cmd-server creates the .megaCmd local cache folder there (as the default HOME location may be erased on restart).
These summaries use the usual conventions - [] indicates its content is optional, | indicates you should choose either the item on the left or the one on the right (but not both)
Each command is described as it would be used in the interactive MEGAcmd shell, and the corresponding scriptable command (which must be prefixed with mega-) works in the same way.
Commands referring to a remote path are talking about a file in your MEGA account online, whereas a local path refers to a file or folder on your local device where MEGAcmd is running.
Verbosity: You can increase the amount of information given by any command by passing -v (-vv, -vvv, ...)
signupemail [password] [--name="Your Name"]Register as user with a given email.confirmlink email [password]Confirm an account using the link provided after the "signup" process.invite[-d|-r] dstemail [--message="MESSAGE"]Invites a contact / deletes an invitation.showpcr[--in | --out]Shows incoming and outgoing contact requests.ipcemail|handle -a|-d|-iManages contact incoming invitations.users[-s] [-h] [-n] [-d contact@email]List contactsuserattr[-s attribute value|attribute] [--user=user@email]Lists/updates user attributespasswd[oldpassword newpassword]Modifies user passwordmasterkeypathtosaveShows your master key.
login[email [password]] | exportedfolderurl#key | sessionLogs into MEGAlogout[--keep-session]Logs outwhoami[-l]Print info of the usersessionPrints (secret) session IDkillsession[-a|sessionid]Kills a session of current user.
cd[remotepath]Changes the current remote folderlcd[localpath]Changes the current local folder for the interactive consolels[-lRr] [remotepath]Lists files in a remote pathpwdPrints the current remote folderlpwdPrints the current local folder for the interactive consoleattrremotepath [-s attribute value|-d attribute]Lists/updates node attributesdu[-h] [remotepath remotepath2 remotepath3 ... ]Prints size used by files/foldersfind[remotepath] [-l] [--pattern=PATTERN] [--mtime=TIMECONSTRAIN] [--size=SIZECONSTRAIN]Find nodes matching a patternmountLists all the main nodes
mkdir[-p] remotepathCreates a directory or a directory hierarchycpsrcremotepath dstremotepath|dstemailCopies a file/folder into a new location (all remotes)put[-c] [-q] [--ignore-quota-warn] localfile [localfile2 localfile3 ...] [dstremotepath]Uploads files/folders to a remote folderget[-m] [-q] [--ignore-quota-warn] exportedlink#key|remotepath [localpath]Downloads a remote file/folder or a public linkpreview[-s] remotepath localpathTo download/upload the preview of a file.thumbnail[-s] remotepath localpathTo download/upload the thumbnail of a file.mvsrcremotepath [srcremotepath2 srcremotepath3 ..] dstremotepathMoves file(s)/folder(s) into a new location (all remotes)rm[-r] [-f] remotepathDeletes a remote file/foldertransfers[-c TAG|-a] | [-r TAG|-a] | [-p TAG|-a] [--only-downloads | --only-uploads] [SHOWOPTIONS]List or operate with transfersspeedlimit[-u|-d] [-h] [NEWLIMIT]Displays/modifies upload/download rate limitssync[localpath dstremotepath| [-dsr] [ID|localpath]Controls synchronizationsexclude[(-a|-d) pattern1 pattern2 pattern3 [--restart-syncs]]Manages exclusions in syncs.backuplocalpath remotepath --period="PERIODSTRING" --num-backups=NSet up a new backup folder and/or schedulebackup[-lhda] [TAG|localpath] [--period="PERIODSTRING"] [--num-backups=N])View/Modify an existing backup schedule
cpsrcremotepath dstremotepath|dstemailMoves a file/folder into a new location (all remotes)export[-d|-a [--expire=TIMEDELAY]] [remotepath]Prints/Modifies the status of current exportsimportexportedfilelink#key [remotepath]Imports the contents of a remote link into your accountshare[-p] [-d|-a [email protected] [--level=LEVEL]] [remotepath]Prints/Modifies the status of current shareswebdav[ [-d] remotepath [--port=PORT] [--public] [--tls --certificate=/path/to/certificate.pem --key=/path/to/certificate.key]]Sets up the ability to download a file from your MEGA account via your PC/device.
version[-l][-c]Prints MEGAcmd versioning and extra infodeleteversions[-f] (--all | remotepath1 remotepath2 ...)Delete prior versions of files to save space.unicodeToggle unicode input enabled/disabled in interactive shellreloadForces a reload of the remote files of the userhelp[-f]Prints list of commandshttps[on|off]Shows if HTTPS is used for transfers. Usehttps onto enable it.clearClear screenlog[-sc] levelPrints/Modifies the current logs leveldebugEnters debugging mode (HIGHLY VERBOSE)exit|quit[--only-shell]Quits MEGAcmd
Lists/updates node attributes
Usage: attr remotepath [-s attribute value|-d attribute]
Options: -s attribute value sets an attribute to a value -d attribute removes the attribute
Sets up or controls backups. (example) (tutorial)
Usage: backup (localpath remotepath --period="PERIODSTRING" --num-backups=N | [-lhda] [TAG|localpath] [--period="PERIODSTRING"] [--num-backups=N])
This command can be used to configure which folders to back up, and how often to do so.
If no argument is given it will list the configured backups.
To get extra info on backups use -l or -h (see Options below)
When a backup of a folder (localfolder) is established in a remote folder (remotepath)
MEGAcmd will create subfolder within the remote path with names like: "localfoldername_bk_TIME"
which shall contain a backup of the local folder at that specific time
In order to configure a backup you need to specify the local and remote paths,
the period and max number of backups to store (see Configuration Options below).
Once configured, you can see extended info asociated to the backup (See Display Options)
Notice that MEGAcmd server need to be running for backups to be created.
Display Options:
-l Show extended info: period, max number, next scheduled backup
or the status of current/last backup
-h Show history of created backups
Backup states:
While a backup is being performed, the backup will be considered and labeled as ONGOING
If a transfer is cancelled or fails, the backup will be considered INCOMPLETE
If a backup is aborted (see -a), all the transfers will be canceled and the backup be ABORTED
If MEGAcmd server stops during a transfer, it will be considered MISCARRIED
Notice that currently when MEGAcmd server is restarted, ongoing and scheduled transfers
will be carried out nevertheless.
If MEGAcmd server is not running when a backup is scheduled and the time for the next one has already arrived, an empty BACKUP will be created with state SKIPPED
If a backup(1) is ONGOING and the time for the next backup(2) arrives, it won't start untill the previous one(1)
is completed, and if by the time the first one(1) ends the time for the next one(3) has already arrived,
an empty BACKUP(2) will be created with state SKIPPED
--path-display-size=N Use a fixed size of N characters for paths
Configuration Options:
--period="PERIODSTRING" Period: either time in TIMEFORMAT (see below) or a cron like expresisions
Cron like period is formatted as follows
- - - - - -
| | | | | |
| | | | | |
| | | | | +---- Day of the Week (range: 1-7, 1 standing for Monday)
| | | | +------ Month of the Year (range: 1-12)
| | | +-------- Day of the Month (range: 1-31)
| | +---------- Hour (range: 0-23)
| +------------ Minute (range: 0-59)
+-------------- Second (range: 0-59)
examples:
- daily at 04:00:00 (UTC): "0 0 4 * * *"
- every 15th day at 00:00:00 (UTC) "0 0 0 15 * *"
- mondays at 04.30.00 (UTC): "0 30 4 * * 1"
TIMEFORMAT can be expressed in hours(h), days(d),
minutes(M), seconds(s), months(m) or years(y)
e.g. "1m12d3h" indicates 1 month, 12 days and 3 hours
Notice that this is an uncertain measure since not all months
last the same and Daylight saving time changes are not considered
If possible use a cron like expresion
Notice: regardless of the period expresion, the first time you establish a backup,
it will be created immediately
--num-backups=N Maximum number of backups to store
After creating the backup (N+1) the oldest one will be deleted
That might not be true in case there are incomplete backups:
in order not to lose data, at least one COMPLETE backup will be kept
Use backup TAG|localpath --option=VALUE to modify existing backups
Management Options:
-d TAG|localpath Removes a backup by its TAG or local path
Folders created by backup won't be deleted
-a TAG|localpath Aborts ongoing backup
Syncs are associated with your Session, so logging out will cancel them.
Caveat: This functionality is in BETA state. If you experience any issue with this, please contact: [email protected]
Changes the current remote folder (example)
Usage: cd [remotepath]
If no folder is provided, it will be changed to the root folder
Clear screen
Usage: clear
Confirm an account using the link provided after the "signup" process. (example)
Usage: confirm link email [password]
It requires the email and the password used to obtain the link.
Moves a file/folder into a new location (all remotes)
Usage: cp srcremotepath dstremotepath|dstemail:
If the location exists and is a folder, the source will be copied there. If the location doesn't exist, the file/folder will be renamed to the destination name given. If "dstemail:" provided, the file/folder will be sent to that user's inbox (//in) e.g: cp /path/to/file [email protected]: Remember the trailing ":", otherwise a file with the name of that user ("[email protected]") will be created
Enters debugging mode (HIGHLY VERBOSE)
Usage: debug
For a finer control of log level see [`log`](#log)
Deletes previous versions of files, keeping the current version.
Usage: deleteversions [-f] (--all | remotepath1 remotepath2 ...)
This will permanently delete all historical versions of a file. The current version of the file will remain. Note: any file version shared to you from a contact will need to be deleted by them. Options: -f Force (no asking) --all Delete versions of all nodes. This will delete the version histories of all files (not current files). To see versions of a file use `ls --versions`. To see space occupied by file versions use `du --versions`.
Prints size used by files/folders (example)
Usage: du [-h] [--versions] [remotepath remotepath2 remotepath3 ... ]
remotepath can be a pattern (it accepts wildcards: ? and *. e.g.: f*00?.txt) Options: -h Human readable --versions Calculate size including all versions. You can remove all versions with `deleteversions` and list them with `ls --versions `
Manages exclusions in syncs.
Usage: exclude [(-a|-d) pattern1 pattern2 pattern3 [--restart-syncs]]
Options:
-a pattern1 pattern2 ... adds pattern(s) to the exclusion list
(* and ? wildcards allowed)
-d pattern1 pattern2 ... deletes pattern(s) from the exclusion list
--restart-syncs Try to restart synchronizations.
Changes will not be applied immediately to actions being performed in active syncs.
After adding/deleting patterns, you might want to:
a) disable/reenable synchronizations manually
b) restart MEGAcmd server
c) use --restart-syncs flag. Caveats:
This will cause active transfers to be restarted
In certain cases --restart-syncs might be unable to re-enable a synchronization.
In such case, you will need to manually resume it or restart MEGAcmd server.
Quits MEGAcmd
Usage: exit [--only-shell]
By default this command will exit both the interactive shell and the command server. To only exit current shell and keep server running, use `exit --only-shell` Exiting the server does not cancel the session, and the encrypted local cache of your account is kept on your PC. The session will be resumed when the service is restarted.
Prints/Modifies the status of current exports (example)
Usage: export [-d|-a [--expire=TIMEDELAY] [-f]] [remotepath]
Options:
-a Adds an export (or modifies it if existing)
--expire=TIMEDELAY Determines the expiration time of a node.
It indicates the delay in hours(h), days(d),
minutes(M), seconds(s), months(m) or years(y)
e.g. "1m12d3h" establish an expiration time 1 month,
12 days and 3 hours after the current moment
-f Implicitly accept copyright terms (only shown the first time an export is made)
MEGA respects the copyrights of others and requires that users of the MEGA cloud service
comply with the laws of copyright.
You are strictly prohibited from using the MEGA cloud service to infringe copyrights.
You may not upload, download, store, share, display, stream, distribute, email, link to,
transmit or otherwise make available any files, data or content that infringes any copyright
or other proprietary rights of any person or entity.
-d Deletes an export
If a remote path is given it'll be used to add/delete or in case of no option selected, it will display all the exports existing in the tree of that path
Find nodes matching a pattern
Usage: find [remotepath] [-l] [--pattern=PATTERN] [--mtime=TIMECONSTRAIN] [--size=SIZECONSTRAIN]
Options:
-l Prints file info
--pattern=PATTERN Pattern to match (it accepts wildcards: ? and *. e.g.: f*00?.txt)
--mtime=TIMECONSTRAIN Determines time constrains, in the form: [+-]TIMEVALUE
TIMEVALUE may include hours(h), days(d), minutes(M), seconds(s), months(m) or years(y)
Examples:
"+1m12d3h" shows files modified before 1 month, 12 days and 3 hours the current moment
"-3h" shows files modified within the last 3 hours
"-3d+1h" shows files modified in the last 3 days prior to the last hour
--size=SIZECONSTRAIN Determines size constrains, in the form: [+-]TIMEVALUE
TIMEVALUE may include (B)ytes, (K)ilobytes, (M)egabytes, (G)igabytes & (T)erabytes
Examples:
"+1m12k3B" shows files bigger than 1 Mega, 12 Kbytes and 3Bytes
"-3M" shows files smaller than 3 Megabytes
"-4M+100K" shows files smaller than 4 Mbytes and bigger than 100 Kbytes
Downloads a remote file/folder or a public link (example)
Usage: get [-m] [-q] [--ignore-quota-warn] exportedlink#key|remotepath [localpath]
If the remotepath is a file, it will be downloaded to folder specified in localpath (or to the current folder if not specified). If the localpath (destination) already exists and is the same (by content) then nothing will be done. If it differs, it will create a new file appending " (NUM)". If the remotepath or exportedlink is a folder, the folder and its entire contents will be downloaded into the destination folder. Options: -q queue download: execute in the background. -m if the folder already exists, the contents will be merged with the downloaded one (preserving the existing files) --ignore-quota-warn ignore quota surpassing warning. The download will be attempted anyway.
Prints list of commands
Usage: help [-f]
Options: -f Include a brief description of the commands
Shows if HTTPS is used for transfers. Use https on to enable it.
Usage: https [on|off]
HTTPS is not necesary since all data is already encrypted before being stored or transfered anyway. Enabling it will increase CPU usage and add network overhead. This setting is ephemeral: it will reset for the next time you open MEGAcmd
Imports the contents of a remote link into your MEGA account or to a local folder. (example)
Usage: import exportedfilelink#key [remotepath]
If no remote path is provided, the current local folder will be used
Invites a contact / deletes an invitation (example)
Usage: invite [-d|-r] dstemail [--message="MESSAGE"]
Options: -d Deletes invitation -r Resends the invitation --message="MESSAGE" Sends the invitation, including your message.
Manages contact incoming invitations. (example)
Usage: ipc email|handle -a|-d|-i
Options: -a Accepts invitation -d Rejects invitation -i Ignores invitation [WARNING: do not use unless you know what you are doing]
Kills a session of current user.
Usage: killsession [-a|sessionid]
Options: -a kills all sessions except the current one To see all sessions use "whoami -l"
Changes the current local folder for the interactive console
Usage: lcd [localpath]
It will be used for uploads and downloads If not using interactive console, the current local folder will be that of the shell executing mega comands
Prints/Modifies the setting for how detailed log output is.
Usage: log [-sc] level
Options:
-c CMD log level (higher level messages).
Messages captured by MEGAcmd server.
-s SDK log level (lower level messages).
Messages captured by the engine and libs
Regardless of the log level of the interactive shell, you can increase the amount of information given by any command by passing `-v` (`-vv`, `-vvv`, ...)
Log into your MEGA account (example)
Usage: login [email [password]] | exportedfolderurl#key | session
You can log in either with email and password, with session ID, or into a folder (an exported/public folder). If logging into a folder indicate url#key
Closes your session for security or to allow subsequently logging into a different account. (example)
Usage: logout [--keep-session]
Options: --keep-session The current session is not closed, allowing logging back into it later using the session ID rather than email/password. MEGAcmd will still log back into your account automatically on restart if you specify --keep-session, similar to exiting it without logging out.
Prints the current local folder for the interactive console
Usage: lpwd
It will be used for uploads and downloads If not using interactive console, the current local folder will be that of the shell executing mega comands
Usage: ls [-halRr] [--versions] [remotepath]
Lists files in a remote path
remotepath can be a pattern (it accepts wildcards: ? and *. e.g.: f*00?.txt)
Also, constructions like /PATTERN1/PATTERN2/PATTERN3 are allowed
Options:
-R|-r list folders recursively
-l print summary
SUMMARY contents:
FLAGS: Indicate type/status of an element:
xxxx
|||+---- Sharing status: (s)hared, (i)n share or not shared(-)
||+----- if exported, whether it is (p)ermanent or (t)temporal
|+------ e/- wheter node is (e)xported
+-------- Type(d=folder,-=file,r=root,i=inbox,b=rubbish,x=unsupported)
VERS: Number of versions in a file
SIZE: Size of the file in bytes:
DATE: Modification date for files and creation date for folders:
NAME: name of the node
-h Show human readable sizes in summary
-a include extra information
--versions show historical versions
You can delete all versions of a file with "deleteversions"
Shows your master key.
Usage: masterkey pathtosave
Getting the master key and keeping it in a secure location enables you to set a new password without data loss. Always keep physical control of your master key (e.g. on a client device, external storage, or print)
Creates a directory or a directories hierarchy (example)
Usage: mkdir [-p] remotepath
Options: -p Allow recursive
Lists all the main nodes (example)
Usage: mount
Copies files/folders to a new location in your MEGA account
Usage: mv srcremotepath [srcremotepath2 srcremotepath3 ..] dstremotepath
If the destination remote path exists and is a folder, the source will be copied there. If the destination remote path doesn't exist, the source will be renamed to the given dstremotepath leaf name.
Modifies user password
Usage: passwd [oldpassword newpassword]
To download/upload the preview of a file.
Usage: preview [-s] remotepath localpath
If no -s is inidicated, it will download the preview. Options: -s Sets the preview to the specified file
Uploads files/folders to a remote folder (example)
Usage: put [-c] [-q] [--ignore-quota-warn] localfile [localfile2 localfile3 ...] [dstremotepath]
Options:
-c Creates remote folder destination in case of not existing.
-q queue upload: execute in the background. Don't wait for it to end'
--ignore-quota-warn ignore quota surpassing warning.
The upload will be attempted anyway.
Notice that the dstremotepath can only be omitted when only one local path is provided.
In such case, the current remote working dir will be the destination for the upload.
Mind that using wildcards for local paths will result in multiple paths.
Prints the current remote folder
Usage: pwd
Usage: quit [--only-shell]
Quits MEGAcmd Notice that the session will still be active, and local caches available The session will be resumed when the service is restarted Be aware that this will exit both the interactive shell and the server. To only exit current shell and keep server running, use "exit --only-shell"
Forces re-downloading the Local Cache information from MEGA.
Usage: reload
It will also resume synchronizations.
Deletes a remote file/folder
Usage: rm [-r] [-f] remotepath
Options: -r Delete recursively (for folders) -f Force (no asking)
Prints (secret) session ID
Usage: session
Prints/Modifies the status of current shares
Usage: share [-p] [-d|-a [email protected] [--level=LEVEL]] [remotepath]
Options:
-p Show pending shares
--with=email Determines the email of the user to [no longer] share with
-d Stop sharing with the selected user
-a Adds a share (or modifies it if existing)
--level=LEVEL Level of acces given to the user
0: Read access
1: Read and write
2: Full access
3: Owner access
If a remote path is given it'll be used to add/delete or in case of no option selected, it will display all the shares existing in the tree of that path
When sharing a folder with a user that is not a contact (see "users --help") the share will be in a pending state. You can list pending shares with `share -p`. Your contact will need to accept your invitation (see [`ipc`](#ipc))
If someone has shared something with you, it will be listed as a root folder.
Use [`mount`](#mount) to list folders shared with you
Shows incoming and outgoing contact requests. (example)
Usage: showpcr [--in | --out]
Options: --in Shows incoming requests --out Shows outgoing invitations
Register as user with a given email (example)
Usage: signup email [password] [--name="Your Name"]
Options: --name="Your Name" Name to register. e.g. "John Smith" You will receive an email to confirm your account. Once you have received the email, please proceed to confirm the link included in that email with "confirm".
Displays/modifies upload/download rate limits
Usage: speedlimit [-u|-d] [-h] [NEWLIMIT]
NEWLIMIT establish the new limit in size per second (0 = no limit) NEWLIMIT may include (B)ytes, (K)ilobytes, (M)egabytes, (G)igabytes & (T)erabytes. Examples: "1m12k3B" "3M". If no units are given, bytes are assumed. Options: -d Download speed limit -u Upload speed limit -h Human readable Notice: these limits are saved for the next time you execute MEGAcmd server. They will be removed if you logout.
Sets up synchronisation between a local folder and one in your MEGA account. (example)
Usage: sync [localpath dstremotepath| [-dsr] [ID|localpath]
If no argument is provided, it lists current configured synchronizations If provided local and remote paths, it will start synchronizing a local folder into a remote folder If an ID/local path is provided, it will list such synchronization unless an option is specified. Options: -d ID|localpath deletes a synchronization -s ID|localpath stops(pauses) a synchronization -r ID|localpath resumes a synchronization --path-display-size=N Use a fixed size of N characters for paths Syncs are associated with your Session, so logging out will cancel them.
To download/upload the thumbnail of a file.
Usage: thumbnail [-s] remotepath localpath
If no -s is inidicated, it will download the thumbnail. Options: -s Sets the thumbnail to the specified file
List or operate with queued transfers (example)
Usage: transfers [-c TAG|-a] | [-r TAG|-a] | [-p TAG|-a] [--only-downloads | --only-uploads] [SHOWOPTIONS]
If executed without option it will list the first 10 tranfers Options: -c (TAG|-a) Cancel transfer with TAG (or all with -a) -p (TAG|-a) Pause transfer with TAG (or all with -a) -r (TAG|-a) Resume transfer with TAG (or all with -a) --only-uploads Show/Operate only upload transfers --only-downloads Show/Operate only download transfers Show options: --summary Prints summary of on going transfers --show-syncs Show synchronization transfers --show-completed Show completed transfers --only-completed Show only completed download --limit=N Show only first N transfers --path-display-size=N Use a fixed size of N characters for paths TYPE legend correspondence: ⇓ = Download transfer ⇑ = Upload transfer ⇵ = Sync transfer. The transfer is done in the context of a synchronization ⏫ = Backup transfer. The transfer is done in the context of a backup
Toggle unicode input enabled/disabled in interactive shell
Usage: unicode
Unicode mode is experimental, you might experience some issues interacting with the console (e.g. history navigation fails). Type "help --unicode" for further info.
Lists/updates user attributes (example)
Usage: userattr [-s attribute value|attribute] [--user=user@email]
Options: -s attribute value sets an attribute to a value --user=user@email select the user to query
List contacts (example)
Usage: users [-s] [-h] [-n] [-d contact@email]
Options: -s Show shared folders with listed contacts -h Show all contacts (hidden, blocked, ...) -n Show users names -d contact@email Deletes the specified contact
Prints MEGAcmd versioning and extra info
Usage: version [-l][-c]
Options: -c Shows changelog for the current version -l Show extended info: MEGA SDK version and features enabled
Configures a WEBDAV server to serve a location in MEGA. You can use feature to make a folder in your MEGA account appear as a virtual drive, or to stream files. (example) (tutorial)
Usage: webdav [ [-d] remotepath [--port=PORT] [--public] [--tls --certificate=/path/to/certificate.pem --key=/path/to/certificate.key]]
This can also be used for streaming files. The server will be running as long as MEGAcmd Server is. If no argument is given, it will list the webdav enabled locations. Options: --d Stops serving that location --public *Allow access from outside localhost --port=PORT *Port to serve. DEFAULT= 4443 --tls *Serve with TLS (HTTPS) --certificate=/path/to/certificate.pem *Path to PEM formated certificate --key=/path/to/certificate.key *Path to PEM formated key *If you serve more than one location, these parameters will be ignored and use those of the first location served. Webdav setup is associated with your Session, so logging out will cancel them. Caveat: This functionality is in BETA state. If you experience any issue with this, please contact: [email protected]
Print account information (example)
Usage: whoami [-l]
Options:
-l Show extended info: total storage used, storage per main folder
(see mount), pro level, account balance, and also the active sessions
MEGA CMD> signup [email protected] --name="test1" New Password: Retype New Password: Account created succesfully. You will receive a confirmation link. Use "confirm" with the provided link to confirm that account MEGA CMD> confirm https://mega.nz/#confirmQFSfjtUkExc5M2Us6q5d-klx60RfxVbxjhk [email protected] Password: Account [email protected] confirmed succesfully. You can login with it now MEGA CMD> signup [email protected] --name="test2" New Password: Retype New Password: Account created succesfully. You will receive a confirmation link. Use "confirm" with the provided link to confirm that account MEGA CMD> confirm https://mega.nz/#confirmcz7Ss68ChhMKk8WEFTQCqLMHJg8esAEEpQE [email protected] Password: Account [email protected] confirmed succesfully. You can login with it now MEGA CMD> login [email protected] Password: [API:info: 23:19:14] Fetching nodes ... [API:info: 23:19:17] Loading transfers from local cache [API:info: 23:19:17] Login complete as [email protected] MEGA CMD> [email protected]:/$ invite [email protected] Invitation to user: [email protected] sent [email protected]:/$ showpcr Outgoing PCRs: [email protected] (id: 47Xhz6wvVTk, creation: Thu, 26 Apr 2018 11:20:09 +1200, modification: Thu, 26 Apr 2018 11:20:09 +1200) [email protected]:/$ logout Logging out... [email protected]:/$ MEGA CMD> login [email protected] Password: [API:info: 23:21:10] Fetching nodes ... [API:info: 23:21:12] Loading transfers from local cache [API:info: 23:21:12] Login complete as [email protected] MEGA CMD> [email protected]:/$ showpcr Incoming PCRs: [email protected] (id: 47Xhz6wvVTk, creation: Thu, 26 Apr 2018 11:20:09 +1200, modification: Thu, 26 Apr 2018 11:20:09 +1200) [email protected]:/$ ipc 47Xhz6wvVTk -a Accepted invitation by [email protected] [email protected]:/$ users [email protected], visible since Thu, 26 Apr 2018 11:22:02 +1200 [email protected]:/$ userattr [email protected] firstname = test1 ed25519 = 5Xl2-mUtsZkaATmSS88Ncepju5805uw66Hfdh_-SwpE cu25519 = ejoYtpaJIZvlpmPsYviIa6tNvPTdVjfkYf9G1k8PKgM rsa = AAAAAFrhDPPMS1AXAhJwScpJ_GKqFUJ42uIIcwxLp5RIalkWtsa5j87u2LFhoZlI_rHIzGXrdsbywgs7Msisw0CjodrtwtME cu255 = AAAAAFrhDPPWUOP2tNByV72zU4M3EKNoddyVCT13VkkouMldniR2UZtLrPjUjUeOZOLvOL7H1C0W0Q_b3QqYSvAKo775pUwD [email protected]:/$ showpcr [email protected]:/$ logout Logging out... MEGA CMD> login [email protected] Password: [API:info: 23:24:26] Fetching nodes ... [API:info: 23:24:27] Loading transfers from local cache [API:info: 23:24:27] Login complete as [email protected] MEGA CMD> [email protected]:/$ showpcr [email protected]:/$ users [email protected], visible [email protected]:/$ userattr [email protected] firstname = test2 ed25519 = M7SLy2RajwUAvynxJQaVkhe6hxGpbwJmvve3dgl8B1o cu25519 = VaXluGS2c5xbo0xOHHJciqLRxwMaWZHVK8iuxtlCBTk rsa = AAAAAFrhDWemabQ4JAOtP7zcoy6m74PsFTFCbj04Zh4G8K_TZB5Sm9T5Xj9CXYzwWnpfRd1McPdDouKdsASQ6Er7i4Y4LpEA cu255 = AAAAAFrhDWcXE_7AHZmvxk5Hk0G7V65UnvFO42tb1gM9SYy3BpsMCas0X-pbqkYwf6_2eBG-ZLvkonGfXB3DWonWNvnVehIB [email protected]:/$
MEGA CMD> login [email protected] Password: [API:info: 23:43:14] Fetching nodes ... [API:info: 23:43:14] Loading transfers from local cache [API:info: 23:43:14] Login complete as [email protected] MEGA CMD> [email protected]:/$ whoami -l Account e-mail: [email protected] Available storage: 50.00 GBytes In ROOT: 146... KBytes in 1 file(s) and 0 folder(s) In INBOX: 0.00 Bytes in 0 file(s) and 0 folder(s) In RUBBISH: 0.00 Bytes in 0 file(s) and 0 folder(s) Total size taken up by file versions: 0.00 Bytes Pro level: 0 Subscription type: Account balance: Current Active Sessions: * Current Session Session ID: m3a8eluyPdo Session start: 4/26/2018 11:43:12 AM Most recent activity: 4/26/2018 11:43:13 AM IP: 122.56.56.232 Country: NZ User-Agent: MEGAcmd/0.9.9.0 (Windows 10.0.16299) MegaClient/3.3.5 ----- 1 active sessions opened [email protected]:/$ mount ROOT on / INBOX on //in RUBBISH on //bin [email protected]:/$ ls Welcome to MEGA.pdf [email protected]:/$ get "Welcome to MEGA.pdf" TRANSFERING ||################################################################################||(1/1 MB: 100.00 %) [email protected]:/$ mkdir my-pictures [email protected]:/$ cd my-pictures/ [email protected]:/my-pictures$ put C:\Users\MYWINDOWSUSER\Pictures TRANSFERING ||################################################################################||(1/1 MB: 100.00 %) [email protected]:/my-pictures$ pwd /my-pictures [email protected]:/my-pictures$ ls Pictures [email protected]:/my-pictures$ cd Pictures/ [email protected]:/my-pictures/my-pictures$ ls Camera Roll Feedback Saved Pictures megacmdpkg.gif megacmdpkg_80.gif megacmdpkg_gray.gif [email protected]:/my-pictures/my-pictures$ pwd /my-pictures/Pictures [email protected]:/my-pictures/my-pictures$ cd / [email protected]:/$ du my-pictures/ FILENAME SIZE my-pictures: 1376143 ---------------------------------------------------------------- Total storage used: 1376143 [email protected]:/$ logout Logging out... MEGA CMD>
[email protected]:/$ sync c:\Go go-backup/ [email protected]:/$ sync ID LOCALPATH REMOTEPATH ActState SyncState SIZE FILES DIRS 0 \\?\c:\Go /go-backup InitScan Syncing 119.13 KB 10 97 [email protected]:/$ sync ID LOCALPATH REMOTEPATH ActState SyncState SIZE FILES DIRS 0 \\?\c:\Go /go-backup InitScan Syncing 61.22 MB 1252 463 [email protected]:/$ sync ID LOCALPATH REMOTEPATH ActState SyncState SIZE FILES DIRS 0 \\?\c:\Go /go-backup InitScan Syncing 232.94 MB 4942 773 [email protected]:/$ sync ID LOCALPATH REMOTEPATH ActState SyncState SIZE FILES DIRS 0 \\?\c:\Go /go-backup Active Synced 285.91 MB 7710 1003 [then on a windows cmd prompt] C:\Users\ME>rmdir /s c:\go\blog c:\go\blog, Are you sure (Y/N)? Y [back in MEGAcmd- update has been applied to MEGA already] [email protected]:/$ sync ID LOCALPATH REMOTEPATH ActState SyncState SIZE FILES DIRS 0 \\?\c:\Go /go-backup Active Synced 268.53 MB 7306 961
[email protected]:/$ backup c:/cmake /cmake-backup --period="0 0 4 * * *" --num-backups=3 Backup established: c:/cmake into /cmake-backup period="0 0 4 * * *" Number-of-Backups=3 [email protected]:/$ backup TAG LOCALPATH REMOTEPARENTPATH STATUS 166 \\?\c:\cmake /cmake-backup ONGOING [email protected]:/$ backup -h TAG LOCALPATH REMOTEPARENTPATH STATUS 166 \\?\c:\cmake /cmake-backup ONGOING -- SAVED BACKUPS -- NAME DATE STATUS FILES FOLDERS cmake_bk_20180426133300 26Apr2018 13:33:00 ONGOING 0 92 [email protected]:/$
[email protected]:/$ webdav myfile.tif --port=1024 Serving via webdav myfile.tif: http://127.0.0.1:1024/5mYHQT4B/myfile.tif [email protected]:/$ webdav WEBDAV SERVED LOCATIONS: /myfile.tif: http://127.0.0.1:1024/5mYHQT4B/myfile.tif [email protected]:/$ webdav -d myfile.tif myfile.tif no longer served via webdav [email protected]:/$
[email protected]:/$ export -a Pictures/ MEGA respects the copyrights of others and requires that users of the MEGA cloud service comply with the laws of copyright. You are strictly prohibited from using the MEGA cloud service to infringe copyrights. You may not upload, download, store, share, display, stream, distribute, email, link to, transmit or otherwise make available any files, data or content that infringes any copyright or other proprietary rights of any person or entity. Do you accept this terms? (Yes/No): Yes Please enter [y]es/[n]o/[a]ll/none:yes Exported /Pictures: https://mega.nz/#F!iaZlEBIL!mQD3rFuJhKov0sco-6s9xg [email protected]:/$ export Pictures (folder, shared as exported permanent folder link: https://mega.nz/#F!iaZlEBIL!mQD3rFuJhKov0sco-6s9xg) [email protected]:/$ logout --keep-session Logging out... Session closed but not deleted. Warning: it will be restored the next time you execute the application. Execute "logout" to delete the session permanently. You can also login with the session id: ARo7aiLAxK-jseOdVBYhj285Twb06ivWsFmT4XAnkTsiaDRRbm5oYS1zRm-V3I0FHHOvwj7P2RPvrSw_ MEGA CMD> login [email protected] Password: [API:info: 01:55:04] Fetching nodes ... [API:info: 01:55:05] Loading transfers from local cache [API:info: 01:55:05] Login complete as [email protected] MEGA CMD> [email protected]:/$ ls Welcome to MEGA.pdf [email protected]:/$ import https://mega.nz/#F!iaZlEBIL!mQD3rFuJhKov0sco-6s9xg Imported folder complete: /Pictures [email protected]:/$ ls Pictures Welcome to MEGA.pdf [email protected]:/$ ls Pictures/ Camera Roll Feedback Saved Pictures megacmdpkg.gif megacmdpkg_80.gif megacmdpkg_gray.gif [email protected]:/$ logout Logging out... [email protected]:/$ MEGA CMD> login ARo7aiLAxK-jseOdVBYhj285Twb06ivWsFmT4XAnkTsiaDRRbm5oYS1zRm-V3I0FHHOvwj7P2RPvrSw_ [email protected]:/$ export Pictures (folder, shared as exported permanent folder link: https://mega.nz/#F!iaZlEBIL!mQD3rFuJhKov0sco-6s9xg) [email protected]:/$ export -d Pictures/ Disabled export: /Pictures [email protected]:/$ export Couldn't find anything exported below current folder. Use -a to export it [email protected]:/$
[email protected]:/tmp-test/Mega.dir$ transfers DIR/SYNC TAG SOURCEPATH DESTINYPATH PROGRESS STATE U 17361 \\?\C:\Users\ME\...ebug\megaapi.obj /tmp-test/Mega.dir/Mega.dir/Debug 100.00% of 2016.62 KB ACTIVE U 17362 \\?\C:\Users\ME\...megaapi_impl.obj /tmp-test/Mega.dir/Mega.dir/Debug 13.64% of 13.85 MB ACTIVE U 17363 \\?\C:\Users\ME\...g\megaclient.obj /tmp-test/Mega.dir/Mega.dir/Debug 0.00% of 15.46 MB QUEUED U 17364 \\?\C:\Users\ME\..._http_parser.obj /tmp-test/Mega.dir/Mega.dir/Debug 0.00% of 85.15 KB QUEUED U 17365 \\?\C:\Users\ME\...ega_utf8proc.obj /tmp-test/Mega.dir/Mega.dir/Debug 0.00% of 312.44 KB QUEUED U 17366 \\?\C:\Users\ME\...\mega_zxcvbn.obj /tmp-test/Mega.dir/Mega.dir/Debug 0.00% of 589.88 KB QUEUED U 17367 \\?\C:\Users\ME\...ir\Debug\net.obj /tmp-test/Mega.dir/Mega.dir/Debug 0.00% of 3.20 MB QUEUED U 17368 \\?\C:\Users\ME\...r\Debug\node.obj /tmp-test/Mega.dir/Mega.dir/Debug 0.00% of 3.73 MB QUEUED U 17369 \\?\C:\Users\ME\...ntactrequest.obj /tmp-test/Mega.dir/Mega.dir/Debug 0.00% of 352.22 KB QUEUED U 17370 \\?\C:\Users\ME\...\Debug\proxy.obj /tmp-test/Mega.dir/Mega.dir/Debug 0.00% of 203.57 KB QUEUED ... Showing first 10 transfers ... [email protected]:/tmp-test/Mega.dir$ transfers -p 17367 Transfer 17367 paused successfully. [email protected]:/tmp-test/Mega.dir$ transfers -c 17370 Transfer 17370 cancelled successfully. [email protected]:/tmp-test/Mega.dir$ transfers DIR/SYNC TAG SOURCEPATH DESTINYPATH PROGRESS STATE U 17362 \\?\C:\Users\ME\...megaapi_impl.obj /tmp-test/Mega.dir/Mega.dir/Debug 96.32% of 13.85 MB ACTIVE U 17363 \\?\C:\Users\ME\...g\megaclient.obj /tmp-test/Mega.dir/Mega.dir/Debug 0.20% of 15.46 MB ACTIVE U 17364 \\?\C:\Users\ME\..._http_parser.obj /tmp-test/Mega.dir/Mega.dir/Debug 0.00% of 85.15 KB QUEUED U 17365 \\?\C:\Users\ME\...ega_utf8proc.obj /tmp-test/Mega.dir/Mega.dir/Debug 0.00% of 312.44 KB QUEUED U 17366 \\?\C:\Users\ME\...\mega_zxcvbn.obj /tmp-test/Mega.dir/Mega.dir/Debug 0.00% of 589.88 KB QUEUED U 17367 \\?\C:\Users\ME\...ir\Debug\net.obj /tmp-test/Mega.dir/Mega.dir/Debug 0.00% of 3.20 MB PAUSED U 17368 \\?\C:\Users\ME\...r\Debug\node.obj /tmp-test/Mega.dir/Mega.dir/Debug 0.00% of 3.73 MB QUEUED U 17369 \\?\C:\Users\ME\...ntactrequest.obj /tmp-test/Mega.dir/Mega.dir/Debug 0.00% of 352.22 KB QUEUED U 17371 \\?\C:\Users\ME\...pubkeyaction.obj /tmp-test/Mega.dir/Mega.dir/Debug 0.00% of 355.75 KB QUEUED U 17372 \\?\C:\Users\ME\...ebug\request.obj /tmp-test/Mega.dir/Mega.dir/Debug 0.00% of 933.14 KB QUEUED ... Showing first 10 transfers ... [email protected]:/tmp-test/Mega.dir$
[email protected]:/$ mount ROOT on / INBOX on //in RUBBISH on //bin INSHARE on [email protected]:photos_Jan_1_2020 (read access) INSHARE on [email protected]:other_folder (read access) [email protected]:/$ ls [email protected]:photos_Jan_1_2020 photo1.jpg photo2.jpg [email protected]:/$ get [email protected]:photos_Jan_1_2020/photo1.jpg TRANSFERRING ||###########################################################################################||(5/5 MB: 100.00 %) Download finished: .\photo1.jpg [email protected]:/$ share -a [email protected] --level=0 "/Camera Uploads/my_photos_from_that_day" Shared /Camera Uploads/my_photos_from_that_day : [email protected] accessLevel=0 [email protected]:/$