2
0
mirror of https://github.com/meganz/MEGAcmd synced 2025-08-31 13:55:10 +00:00

Update command docsfollowing latest changes

This commit is contained in:
Diego Ximenez
2024-06-27 20:47:37 +02:00
parent 751599ae1c
commit 9d0c8a5c7b
4 changed files with 89 additions and 87 deletions

View File

@@ -7,10 +7,10 @@ Options:
--use-pcre The provided path will use Perl Compatible Regular Expressions (PCRE)
-a Adds an export.
Returns an error if the export already exists.
To modify an existing export (e.g., to change expiration time, password, etc.), it must be deleted and then re-added.
--writable Makes the export writable.
Only works on folders; files are considered immutable. Different versions of the same file will have different export links.
The AuthToken shown has the following format <handle>#<key>:<auth-key>.
To modify an existing export (e.g. to change expiration time, password, etc.), it must be deleted and then re-added.
--writable Turn an export folder into a writable folder link. You can use writable folder links to share and receive files from anyone; including people who dont have a MEGA account.
This type of link is the same as a "file request" link that can be created through the webclient, except that writable folder links are not write-only. Writable folder links and file requests cannot be mixed, as they use different encryption schemes.
The auth-key shown has the following format <handle>#<key>:<auth-key>. The auth-key must be provided at login, otherwise you will log into this link with read-only privileges. See "mega-login --help" for more details about logging into links.
--mega-hosted The share key of this specific folder will be shared with MEGA.
This is intended to be used for folders accessible through MEGA's S4 service.
Encryption will occur nonetheless within MEGA's S4 service.

View File

@@ -1,17 +1,18 @@
### login
Logs into a MEGA account
Logs into a MEGA account or folder link. You can only log into one entity at a time.
Usage: `login [--auth-code=XXXX] email password | exportedfolderurl#key [--auth-key=XXXX] | passwordprotectedlink [--password=PASSWORD] | session`
<pre>
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 (or pasword protected link)
Pass --auth-key=XXXX with the authentication key (last part of the Auth Token)
to be able to write into the accessed folder
Please, avoid using passwords containing " or '.
Logging into a MEGA account:
You can log into a MEGA account by providing either a session ID or a username and password. A session ID simply identifies a session that you have previously logged in with using a username and password; logging in with a session ID simply resumes that session. If this is your first time logging in, you will need to do so with a username and password.
Options:
--auth-code=XXXX Two-factor Authentication code. More info: https://mega.nz/blog_48
--password=XXXX Password to decrypt password protected links (See "mega-export --help")
--auth-code=XXXXXX: If you're logging in using a username and password, and this account has multifactor authentication (MFA) enabled, then this option allows you to pass the MFA token in directly rather than being prompted for it later on. For more information on this topic, please visit https://mega.nz/blog_48.
Logging into a MEGA folder link (an exported/public folder):
MEGA folder links have the form URL#KEY. To log into one, simply execute the login command with the link.
Options:
--password=PASSWORD: If the link is a password protected link, then this option can be used to pass in the password for that link.
--auth-key=AUTHKEY: If the link is a writable folder link, then this option allows you to log in with write privileges. Without this option, you will log into the link with read access only.
For more information about MEGA folder links, see "mega-export --help".
</pre>