💚 End-to-end encrypted cloud for everything.
Dart 2faandroidauthye2eeencryptionend-to-end-encryptionfluttergolanggoogle-photosgoogle-photos-alternativeiosopensourcephotosprivacyprivacy-toolstypescriptzero-knowledge
Publish Ente CLI guides
Manav Rathi6aadb9d2c32b
diff --git a/docs/docs/.vitepress/config.ts b/docs/docs/.vitepress/config.tsindex 3d121364b9..b1447de2d5 100644--- a/docs/docs/.vitepress/config.ts+++ b/docs/docs/.vitepress/config.ts@@ -13,8 +13,6 @@ export default defineConfig({["link", { rel: "icon", type: "image/png", href: "/help/favicon.png" }],],cleanUrls: true,- // TODO: Remove after publishing the first CLI release.- srcExclude: ["cli/**"],ignoreDeadLinks: "localhostLinks",sitemap: {hostname: `${docsBaseUrl}/`,diff --git a/docs/docs/.vitepress/sidebar.ts b/docs/docs/.vitepress/sidebar.tsindex 0ca750ba6f..7b38c76bb3 100644--- a/docs/docs/.vitepress/sidebar.ts+++ b/docs/docs/.vitepress/sidebar.ts@@ -231,7 +231,7 @@ export const sidebar = [},{text: "CLI",- link: "/photos/features/utilities/cli",+ link: "/cli/photos",},{text: "Collage",@@ -601,6 +601,23 @@ export const sidebar = [},],},+ {+ text: "CLI",+ collapsed: true,+ items: [+ { text: "Introduction", link: "/cli/" },+ { text: "Installation", link: "/cli/install" },+ { text: "Accounts", link: "/cli/accounts" },+ { text: "Photos", link: "/cli/photos" },+ { text: "Auth", link: "/cli/auth" },+ { text: "Paste", link: "/cli/paste" },+ { text: "Administration", link: "/cli/admin" },+ { text: "Automation", link: "/cli/automation" },+ { text: "Migration", link: "/cli/migration" },+ { text: "Troubleshooting", link: "/cli/troubleshooting" },+ { text: "Changelog", link: "/cli/changelog" },+ ],+ },{text: "Toys",collapsed: false,@@ -701,7 +718,7 @@ export const sidebar = [},{text: "Ente CLI",- link: "/self-hosting/administration/cli",+ link: "/cli/admin",},{text: "Backup",@@ -771,7 +788,7 @@ export const sidebar = [},{text: "Ente CLI",- link: "/self-hosting/troubleshooting/cli",+ link: "/cli/troubleshooting",},],},diff --git a/docs/docs/auth/faq/installing.md b/docs/docs/auth/faq/installing.mdindex f82c5f3d3d..83f31536e6 100644--- a/docs/docs/auth/faq/installing.md+++ b/docs/docs/auth/faq/installing.md@@ -100,4 +100,4 @@ If Auth cannot start and Windows reports that `MSVCP140.dll` is missing, see the# CLI-Ente's CLI is distributed directly over [GitHub](https://github.com/ente/ente/releases?q=tag%3Acli-v0).+Use the CLI to back up your Auth codes or show a current code. Learn more in [Install Ente CLI](/cli/install) and [Auth](/cli/auth).diff --git a/docs/docs/auth/migration/export.md b/docs/docs/auth/migration/export.mdindex e084de23cb..25bb54f633 100644--- a/docs/docs/auth/migration/export.md+++ b/docs/docs/auth/migration/export.md@@ -69,15 +69,14 @@ The Auth data is encrypted with `XChaCha20-Poly1305`. The encryption key is deri## Automated backups-You can use [Ente's CLI](https://github.com/ente/ente/tree/main/cli#readme) to automatically backup your Auth codes.--To export your data, add an account using `ente account add` command. In the first step, specify `auth` as the app name. At a later point, CLI will also ask you specify the path where it should write the exported codes.--You can change the export directory using following command+[Install Ente CLI](/cli/install), then log in and choose a backup directory:+```sh+ente account login --app auth+ente auth export "$HOME/Backups/Auth"```-ente account update --app auth --email <email> --dir <path>-```++The export asks for a password and writes a dated encrypted backup. Learn more in [Auth](/cli/auth) and [Automation](/cli/automation#back-up-auth-codes) for scheduled backups. If you use the previous CLI, follow [Migration](/cli/migration) first.## Local backups@@ -109,8 +108,10 @@ You can trigger a manual backup at any time using the **Create backup now** butt> Settings -> Data -> Import Codes -> Ente Encrypted export.-- **Decrypt using Ente CLI** : Download the latest version of [Ente CLI](https://github.com/ente/ente/releases?q=tag%3Acli-v0), and run the following command+- **Decrypt using Ente CLI**: [Install Ente CLI](/cli/install), then run:-```- ./ente auth decrypt <export_file> <output_file>-```+ ```sh+ ente auth decrypt backup.json --output codes.txt+ ```++ Enter the backup's password when prompted. The output file must not already exist; it contains unencrypted codes. Learn more in [Auth](/cli/auth#decrypt-a-backup).diff --git a/docs/docs/cli/accounts.md b/docs/docs/cli/accounts.mdindex 6a4e6d84f2..a1f4694ef8 100644--- a/docs/docs/cli/accounts.md+++ b/docs/docs/cli/accounts.md@@ -3,13 +3,13 @@Log in to Photos:```sh-ente account login --account personal --app photos+ente account login --app photos```The CLI asks for your email and password, then for an email verification code or an authenticator code when your account requires one. When it works, it prints the saved account:```-Name personal+Name [email protected]Email [email protected]Host https://api.ente.comLogged in photos@@ -26,7 +26,7 @@ If your account uses a passkey, the CLI opens your browser, or prints the link iEach app has its own login. Log the same account into Auth:```sh-ente account login --account personal --app auth+ente account login --app auth````Logged in` now shows `photos,auth`.@@ -46,23 +46,23 @@ ente account list``````-SELECTED NAME EMAIL HOST LOGGED IN ID-* personal [email protected] https://api.ente.com photos,auth 1580559962386438- home-server [email protected] https://api.example.org photos 3+SELECTED NAME EMAIL HOST LOGGED IN ID+ [email protected] [email protected] https://api.ente.com photos,auth 1580559962386438+* home-server [email protected] https://api.example.org photos 3```-Commands use the selected account. Adding an account selects it; logging in to an existing one keeps the selection. Change the selection with `ente account switch home-server`, or pick an account for one command with `--account NAME` after the subcommand. `ente account rename personal alice` changes a local name.+Commands use the selected account. Adding an account selects it; logging in to an existing one keeps the selection. Change the selection with `ente account switch home-server`, or pick an account for one command with `--account NAME` after the subcommand. `ente account rename [email protected] personal` changes a local name.## Create an account```sh-ente account create --account personal --app photos+ente account create --app photos```-The CLI asks for your email, consent to the terms, the verification code it emails you, and a password. It prints `Created personal and signed into Ente Photos.` Then print and store your recovery key:+The CLI asks for your email, consent to the terms, the verification code it emails you, and a password. It prints `Created [email protected] and signed into Ente Photos.` Then print and store your recovery key:```sh-ente account recovery-key --account personal+ente account recovery-key```If creation is interrupted, run the same `account create` command again with the same CLI home and password; it resumes with its saved keys. If the server already has the account, run `ente account login` instead; it completes the login and clears the unfinished creation.@@ -91,7 +91,7 @@ ente account login --account personal --app photos --input credentials.json --no## Protect login with an authenticator```sh-ente account totp enable --account personal+ente account totp enable```The CLI prints a secret to add to your authenticator app, asks for a code from it, and prints `Authenticator protection is enabled.` Without prompts, run `ente account totp setup` to get the secret, then `ente account totp enable --input -` with `{"secret": "...", "totp": "..."}`. `ente account totp status` shows the current setting. This protects your account login and is separate from the codes stored in Auth.@@ -99,7 +99,7 @@ The CLI prints a secret to add to your authenticator app, asks for a code from i## Get a token```sh-ente account token --account personal --app photos+ente account token --app photos```Prints the saved API token for that app login. It is a secret. With `--json` the result is `{"token": "..."}`.@@ -107,10 +107,10 @@ Prints the saved API token for that app login. It is a secret. With `--json` the## Log out```sh-ente account logout --account personal --app auth+ente account logout --app auth```-Prints `Logged out of Ente Auth for "personal".` Without `--app`, the CLI logs out of every app and removes the account and its local data: `Logged out of Ente Photos and Ente Auth. Removed account "personal" from this device.` `ente account logout --account personal --local` forgets the account on this computer without contacting the server; it cannot be combined with `--app`.+Prints `Logged out of Ente Auth for "[email protected]".` Without `--app`, the CLI logs out of every app and removes the account and its local data: `Logged out of Ente Photos and Ente Auth. Removed account "[email protected]" from this device.` `ente account logout --local` forgets the account on this computer without contacting the server; it cannot be combined with `--app`.## CLI homediff --git a/docs/docs/cli/auth.md b/docs/docs/cli/auth.mdindex 66b53664c7..57c6feee4b 100644--- a/docs/docs/cli/auth.md+++ b/docs/docs/cli/auth.md@@ -3,8 +3,8 @@Make an encrypted backup of your codes:```sh-ente account login --account personal --app auth-ente auth export "$HOME/Backups/Auth" --account personal+ente account login --app auth+ente auth export "$HOME/Backups/Auth"```The CLI asks for an export password and its confirmation, refreshes your codes from the server, and prints:@@ -30,7 +30,7 @@ Prints `Decrypted to codes.txt.` The output is one `otpauth://` link per line. N## Show a current code```sh-ente auth code view github --account personal+ente auth code view github``````@@ -48,8 +48,8 @@ Add `--offline` to `code list`, `code view` or `export` to use the codes synced## Export plaintext or stream to stdout```sh-ente auth export "$HOME/Backups/Auth" --plaintext --account personal-ente auth export --output - --account personal > backup.json+ente auth export "$HOME/Backups/Auth" --plaintext+ente auth export --output - > backup.json````--plaintext` writes unencrypted `otpauth://` links to a dated `.txt` file. `--output PATH` writes to that exact file and refuses to overwrite it; `--output -` writes the backup to stdout with no summary.diff --git a/docs/docs/cli/automation.md b/docs/docs/cli/automation.mdindex f089210d1c..34b3ffdc5e 100644--- a/docs/docs/cli/automation.md+++ b/docs/docs/cli/automation.md@@ -108,8 +108,8 @@ exec "$HOME/.local/opt/ente-cli/bin/ente" auth export "$HOME/Backups/Auth" --acc## Make an API request```sh-ente photos api /collections/v2 --query sinceTime=0 --account personal-ente auth api /authenticator/key --account personal+ente photos api /collections/v2 --query sinceTime=0+ente auth api /authenticator/key```The CLI adds your token and sends the request to the account's server. The response body is written unchanged; a response status outside 2xx exits with status 1 after the body. `--body PATH` and `--headers PATH` read a request body or a JSON object of headers from a file, or from stdin with `-`.diff --git a/docs/docs/cli/index.md b/docs/docs/cli/index.mdindex e799bb9d6e..fbc97ade93 100644--- a/docs/docs/cli/index.md+++ b/docs/docs/cli/index.md@@ -7,8 +7,8 @@[Install the CLI](./install.md), then log in and export:```sh-ente account login --account personal --app photos-ente photos export "$HOME/Pictures/Ente" --account personal+ente account login --app photos+ente photos export "$HOME/Pictures/Ente"```Login asks for your email and password, and for a verification code when your account requires one. The export prints progress while it runs and ends with a summary:diff --git a/docs/docs/cli/migration.md b/docs/docs/cli/migration.mdindex e1b6691c5d..3ee2106cf7 100644--- a/docs/docs/cli/migration.md+++ b/docs/docs/cli/migration.md@@ -1,6 +1,6 @@# Migration-Ente's original CLI was written in Go. The new CLI, written in Rust, was introduced in October 2026 starting with version 0.4.0. The previous CLI (the `cli-v0.x` releases) keeps working and stays supported during the transition, but new development happens only in the new CLI.+Ente's original CLI was written in Go. The new CLI, written in Rust, was introduced in October 2026 starting with version 0.4.0. The previous CLI (the `cli-v0.3.x` releases) keeps working and stays supported during the transition, but new development happens only in the new CLI.The two can be installed side by side, and nothing changes until you act: the new CLI does not read the previous CLI's settings or credentials, and it leaves your exports alone until you ask it to adopt them. Commands have changed; `ente help migration` prints each old command next to its replacement.@@ -13,6 +13,8 @@ A typical switch, for someone whose previous CLI keeps a Photos export up to datEach step, every command and option change, and scripts that parse output are covered below.+Instructions for the previous CLI remain available for [Photos exports](/photos/features/utilities/cli) and [self-hosted servers](/self-hosting/administration/cli).+## Identify which executable runs```sh@@ -34,19 +36,19 @@ See all command changes with:## Log in again```sh-ente account login --account personal --app photos-ente account login --account personal --app auth+ente account login --app photos+ente account login --app auth```-Each app needs its own login. Accounts are selected by a local name with `--account`, not by email. The CLI home replaces the previous configuration directory: set `ENTE_CLI_HOME` where you used `ENTE_CLI_CONFIG_DIR`. `ENTE_CLI_SECRETS_PATH` has no equivalent; for a headless machine, use `ENTE_CLI_VAULT_KEY` as described in [Accounts](./accounts.md#set-up-a-headless-machine). Learn more in [Accounts](./accounts.md).+Each app needs its own login. Commands use the selected account. Use `--account NAME` to choose another saved account by its local name. The CLI home replaces the previous configuration directory: set `ENTE_CLI_HOME` where you used `ENTE_CLI_CONFIG_DIR`. `ENTE_CLI_SECRETS_PATH` has no equivalent; for a headless machine, use `ENTE_CLI_VAULT_KEY` as described in [Accounts](./accounts.md#set-up-a-headless-machine). Learn more in [Accounts](./accounts.md).## Replace saved export jobsThe previous CLI stored an export directory per account (`account update --dir`) and exported every account with one `export` command. The new CLI takes the destination on each run, one command per account and app:```sh-ente photos export "$HOME/Pictures/Ente" --account personal-ente auth export "$HOME/Backups/Auth" --account personal+ente photos export "$HOME/Pictures/Ente"+ente auth export "$HOME/Backups/Auth"```Update your cron jobs or scheduled tasks accordingly. Learn more in [Automation](./automation.md).@@ -57,8 +59,8 @@ The new CLI can adopt (`--adopt`) an export made by the previous CLI and keep ma1. Stop the previous CLI's export job, and any schedule that runs it.2. Keep a copy of the export directory if you want a way back.-3. Log in: `ente account login --account personal --app photos`.-4. Run `ente photos export "$HOME/Pictures/Ente" --adopt --account personal`. Pass the same album filters the previous job used (`--album` for each album, `--exclude-album`, `--exclude-shared`, `--exclude-hidden`), or none when it exported everything. The CLI checks the existing files before taking over.+3. Log in: `ente account login --app photos`.+4. Run `ente photos export "$HOME/Pictures/Ente" --adopt`. Pass the same album filters the previous job used (`--album` for each album, `--exclude-album`, `--exclude-shared`, `--exclude-hidden`), or none when it exported everything. The CLI checks the existing files before taking over.5. Check the summary line: every album copy should be complete with no failures, and the previous CLI's files should be in place under their album folders.6. Point your schedule at the new command without `--adopt` but with the same album filters; a run without them exports every album.diff --git a/docs/docs/cli/photos.md b/docs/docs/cli/photos.mdindex 885c323c83..bb34be2c66 100644--- a/docs/docs/cli/photos.md+++ b/docs/docs/cli/photos.md@@ -3,7 +3,7 @@Export your library to a directory:```sh-ente photos export "$HOME/Pictures/Ente" --account personal+ente photos export "$HOME/Pictures/Ente"```Progress goes to the terminal while originals download:@@ -21,8 +21,8 @@ An album copy is a photo placed in an album; a photo in two albums is two copies## Choose albums```sh-ente photos export "$HOME/Pictures/Ente" --album Holidays --album Family --account personal-ente photos export "$HOME/Pictures/Ente" --exclude-album Screenshots --exclude-shared --exclude-hidden --account personal+ente photos export "$HOME/Pictures/Ente" --album Holidays --album Family+ente photos export "$HOME/Pictures/Ente" --exclude-album Screenshots --exclude-shared --exclude-hidden```An album selector is an album ID or its exact, case-sensitive name; find both with `ente photos album list`. `--exclude-shared` leaves out albums owned by other accounts, and `--exclude-hidden` leaves out hidden albums; files hidden individually inside an exported album are still exported. Filters apply to the run you pass them to; files already exported from an album you now exclude stay where they are.@@ -60,7 +60,7 @@ Run the same command again. Unchanged files are reused, new files are exported,## Save space with hard links```sh-ente photos export "$HOME/Pictures/Ente" --hardlinks --account personal+ente photos export "$HOME/Pictures/Ente" --hardlinks```A photo that is in several albums is stored once and linked from each exported album folder; the copy it links to can also be in `Trash/` or in an album you no longer export. Linked files share contents, timestamps and permissions: editing one changes every copy. Later runs without the flag keep the links. The destination filesystem must support hard links.@@ -75,17 +75,17 @@ Error: cannot open Photos export /home/alice/Pictures/Ente: This folder contains1. Stop the previous CLI job or the desktop app's export.2. Log in with the account that made the export.-3. Run `ente photos export "$HOME/Pictures/Ente" --adopt --account personal`, with the same album filters as before or none. The CLI checks the existing files before taking over.+3. Run `ente photos export "$HOME/Pictures/Ente" --adopt`, with the same album filters as before or none. The CLI checks the existing files before taking over.The flag cannot adopt an arbitrary folder of photos; the folder must contain an export it recognises. Learn more in [Migration](./migration.md#take-over-a-photos-export).## Find and download a file```sh-ente photos album list --account personal-ente photos file list --album Holidays --account personal-ente photos file view IMG_0001.jpg --account personal-ente photos file download 1580559962386999 --output ./IMG_0001.jpg --account personal+ente photos album list+ente photos file list --album Holidays+ente photos file view IMG_0001.jpg+ente photos file download 1580559962386999 --output ./IMG_0001.jpg```A file selector is a file ID or an exact name; when several files share a name, the CLI lists the candidates and you pick an ID. Download prints `Downloaded "IMG_0001.jpg" to ./IMG_0001.jpg.` and refuses to overwrite an existing file. A Live Photo downloads as a ZIP archive. Lists show 100 results and then print `Showing first 100 results; use --limit N or --all to see more.` on the terminal.diff --git a/docs/docs/index.md b/docs/docs/index.mdindex 77b67df2a9..706af0491f 100644--- a/docs/docs/index.md+++ b/docs/docs/index.md@@ -30,6 +30,8 @@ But one day, he discovered that "ente" means "duck" in German. This unexpected cWe recommend reading the documentation for [Ente Photos](/photos/), [Ente Auth](/auth/), or [Ente Locker](/locker/) to get started with installation on the desired platform, explore available features and usage.+To use Ente from a terminal, script or agent, start with [Ente CLI](/cli/).+If you are looking to self-host Ente, we recommend you to read the [official documentation](/self-hosting/) for updated information on getting started, installation, administration and maintenance.## Contributingdiff --git a/docs/docs/photos/faq/account-creation.md b/docs/docs/photos/faq/account-creation.mdindex f01edcb316..1cd38c944f 100644--- a/docs/docs/photos/faq/account-creation.md+++ b/docs/docs/photos/faq/account-creation.md@@ -35,11 +35,7 @@ You can install Ente Photos on your desktop by downloading the installer from [o### How do I install CLI for Ente Photos? {#install-cli}-Ente's CLI is distributed directly over [GitHub](https://github.com/ente/ente/releases?q=tag%3Acli-v0). The CLI is useful for:--- Automated exports to NAS or local storage-- Bulk operations-- Server-to-server transfers+Follow [Install Ente CLI](/cli/install) to download and set up the CLI on Linux, macOS or Windows. Use it to export your library to a local disk or NAS, choose albums, and download individual files.### Can I access Ente Photos from my browser? {#web-app}diff --git a/docs/docs/photos/faq/advanced-features.md b/docs/docs/photos/faq/advanced-features.mdindex 93e7450827..af116e9bb2 100644--- a/docs/docs/photos/faq/advanced-features.md+++ b/docs/docs/photos/faq/advanced-features.md@@ -9,71 +9,30 @@ description: Frequently asked questions about CLI, exports, and advanced feature### What is the Ente CLI? {#what-is-cli}-The Ente CLI is a command-line tool for advanced users that allows you to:--- Export your entire library or specific albums to local storage-- Set up automated exports with cron jobs-- Sync data to NAS or other storage systems-- Perform bulk operations--The CLI is particularly useful for:--- Regular automated backups to local/NAS storage-- Server-to-server transfers-- Power users who prefer command-line tools--For complete details, see the [CLI feature guide](/photos/features/utilities/cli).+Ente CLI is Ente's client for terminals and agents. Use it to export your Photos library, select albums, download individual files, and schedule backups to a local disk or NAS. Learn more in [Ente CLI](/cli/).### How do I install the CLI? {#install-cli-advanced}-Ente's CLI is distributed directly over [GitHub](https://github.com/ente/ente/releases?q=tag%3Acli-v0).--Download the appropriate version for your platform and follow the installation instructions in the [CLI README](https://github.com/ente/ente/tree/main/cli#readme).--Learn more in the [CLI installation guide](/photos/features/utilities/cli#installation).+Follow [Install Ente CLI](/cli/install) for downloads and setup on Linux, macOS and Windows. If you already use the previous CLI, follow [Migration](/cli/migration).### How do I use the CLI to export my photos? {#cli-export-photos}-The CLI supports incremental exports, which means it will only download new or changed files. Configure the export directory for the account once, then run exports whenever you need:+Log in, then choose a destination:```sh-# Configure where this account should export files-ente account update --app photos --email [email protected] --dir /path/to/backup--# Export all photos to that directory-ente export--# Export specific albums-ente export --albums "Album Name","Another Album"+ente account login --app photos+ente photos export "$HOME/Pictures/Ente"```-The exports are incremental and will gracefully handle interruptions - you can safely stop and restart without re-downloading everything.+Run the export command again to pick up changes. Add `--album "Family" --album "Holidays"` to select albums. To continue an export made by the previous CLI, follow [Migration](/cli/migration#take-over-a-photos-export) before running the new command against it.-For complete documentation, see the [CLI feature guide](/photos/features/utilities/cli#basic-usage).+Learn more in [Photos](/cli/photos).### How do I keep NAS and Ente photos synced? {#nas-sync}-The recommended approach is to use the CLI to pull data from Ente to your NAS:--1. Install the CLI on your NAS or a machine that can access it-2. Set up a cron job to run periodic exports-3. Use the CLI's incremental export feature--Example cron job for daily sync:--```sh-# Run once to set up the export directory-/usr/local/bin/ente account update --app photos --email [email protected] --dir /nas/ente-backup--# Cron entry-0 2 * * * /usr/local/bin/ente export-```--See the [CLI NAS sync guide](/photos/features/utilities/cli#nas-sync-setup) for detailed setup.+Run `ente photos export /nas/ente-backup` on a machine with the NAS mounted. [Automation](/cli/automation) shows cron and Task Scheduler setups, including credentials for unattended runs.-> [!NOTE]->-> Two-way sync is not currently supported. The CLI pulls data from Ente to your local storage.+Exports pull changes from Ente to your disk. Local edits are not uploaded to Ente.### CLI not found after installation {#cli-not-found}@@ -109,7 +68,7 @@ You can use our CLI tool or our desktop app to set up exports of your data to yoOpen `Settings > Export data`, choose a destination folder, and enable "Continuous export" to automatically export new items.-**CLI**: Use [Ente's CLI](https://github.com/ente/ente/tree/main/cli#export) to export your data in a cron job to a location of your choice. The exports are incremental, and will also gracefully handle interruptions.+**CLI**: Use [Ente CLI](/cli/automation) to export your data in a cron job to a location of your choice. The exports are incremental, and will also gracefully handle interruptions.For complete details, see the [Export feature guide](/photos/features/backup-and-sync/export).diff --git a/docs/docs/photos/faq/metadata-and-editing.md b/docs/docs/photos/faq/metadata-and-editing.mdindex 73c2a09b4f..196f249567 100644--- a/docs/docs/photos/faq/metadata-and-editing.md+++ b/docs/docs/photos/faq/metadata-and-editing.md@@ -331,7 +331,7 @@ See [original files during export](#modify-originals) and [file-system creationNo. Ente exports the original photos and videos without changing their embedded metadata. Metadata imported from Google Takeout JSON files and changes you make in Ente are written separately to metadata JSON files during library export.-Keep those sidecars with the originals when transferring to another app that supports them. See [the export metadata format](#export-data-preserve-metadata). To export selected albums with their metadata, you can also use [CLI photo export](/photos/features/utilities/cli#exporting-photos).+Keep those sidecars with the originals when transferring to another app that supports them. See [the export metadata format](#export-data-preserve-metadata). To export selected albums with their metadata, you can also use [CLI photo export](/cli/photos).### How can I read the date used by Ente from my export? {#read-corrected-date-export}diff --git a/docs/docs/photos/faq/storage-and-plans.md b/docs/docs/photos/faq/storage-and-plans.mdindex 3afdf20d0a..7db5c06361 100644--- a/docs/docs/photos/faq/storage-and-plans.md+++ b/docs/docs/photos/faq/storage-and-plans.md@@ -518,7 +518,7 @@ When your subscription expires, you enter a **30-day grace period** before your2. **Export your data** during the grace period:- Use the desktop app's export feature- - Or use the [CLI tool](https://github.com/ente/ente/tree/main/cli#readme) for automated export+ - Or use the [CLI tool](/cli/photos) for automated export- Download all photos to your computer or NAS- Learn more in the [Export guide](/photos/migration/export/)diff --git a/docs/docs/photos/features/backup-and-sync/export.md b/docs/docs/photos/features/backup-and-sync/export.mdindex 5510145565..a545d100f0 100644--- a/docs/docs/photos/features/backup-and-sync/export.md+++ b/docs/docs/photos/features/backup-and-sync/export.md@@ -43,10 +43,10 @@ The desktop app offers continuous export, which automatically exports new items### CLI export-For advanced users and automation, use the [Ente CLI](/photos/features/utilities/cli) to export via command line. The CLI is particularly useful for:+For advanced users and automation, use the [Ente CLI](/cli/photos) to export via command line. The CLI is particularly useful for:- Automated exports with cron jobs-- Server-to-server transfers+- Exports from headless servers- NAS sync setups## What gets exported@@ -70,21 +70,14 @@ export-folder/### Metadata preservation-Metadata is exported as separate JSON files alongside your photos. The original files are not modified. The metadata folder name differs depending on whether you export using Ente Desktop or the Ente CLI.--**Ente Desktop Format:**+Metadata is exported as separate JSON files alongside your photos. The original files are not modified. Ente Desktop and the current Ente CLI both use a `metadata/` folder.```photo.jpgmetadata/photo.jpg.json```-**Ente CLI Format:**--```-photo.jpg-.meta/photo.jpg.json-```+The previous CLI used `.meta/` instead. Learn more about the current layout in [Photos](/cli/photos#export-layout).The JSON format matches Google Takeout format, so tools that support Google Takeout imports can read Ente's exported metadata.@@ -95,9 +88,9 @@ For details about the metadata format, see [Metadata and Editing FAQ](/photos/faIf a photo exists in multiple albums:- **In Ente**: Counts as 1 file (storage counted once)-- **On export**: Appears in each album folder (downloaded multiple times)+- **On export**: Appears in each album folder-This is why your export size may be larger than your Ente storage usage.+This is why your export size may be larger than your Ente storage usage. The CLI can save space by [sharing originals through hard links](/cli/photos#save-space-with-hard-links).### Shared albums on export@@ -153,5 +146,5 @@ Both desktop continuous export and CLI exports are **incremental**:## Related topics-- [CLI](/photos/features/utilities/cli) - Command-line tool for automated exports+- [CLI](/cli/photos) - Command-line tool for automated exports- [Watch folders](/photos/features/backup-and-sync/watch-folders) - Automatic uploads (the counterpart to export)diff --git a/docs/docs/photos/features/utilities/cli.md b/docs/docs/photos/features/utilities/cli.mdindex d03a2c143e..64112ac901 100644--- a/docs/docs/photos/features/utilities/cli.md+++ b/docs/docs/photos/features/utilities/cli.md@@ -5,6 +5,8 @@ description: Ente's command-line tool for advanced users# CLI (Command Line Interface)+This page covers the previous CLI. For the current CLI, see [Photos export](/cli/photos). To switch versions, follow [Migration](/cli/migration).+The Ente CLI is a command-line tool for advanced users that provides programmatic access to Ente Photos. It's particularly useful for automation, server environments, and power users who prefer terminal-based tools.## What is the CLI?@@ -46,7 +48,7 @@ Ente's CLI is distributed directly over [GitHub](https://github.com/ente/ente/reBefore using the CLI, you need to authenticate:```sh-ente account login+ente account add```This will prompt for your email and password, then store your session securely.@@ -176,7 +178,7 @@ You can review, contribute to, or extend the CLI for your specific needs.## Related FAQs- [What is the Ente CLI?](/photos/faq/advanced-features#what-is-cli)-- [How do I install the CLI?](/photos/faq/advanced-features#install-cli)+- [How do I install the CLI?](/photos/faq/advanced-features#install-cli-advanced)- [How do I export photos with CLI?](/photos/faq/advanced-features#cli-export-photos)- [How do I sync NAS and Ente?](/photos/faq/advanced-features#nas-sync)- [CLI not found after installation](/photos/faq/advanced-features#cli-not-found)diff --git a/docs/docs/photos/getting-started/installation.md b/docs/docs/photos/getting-started/installation.mdindex 7fa6f5cea6..91c1fa415b 100644--- a/docs/docs/photos/getting-started/installation.md+++ b/docs/docs/photos/getting-started/installation.md@@ -52,7 +52,7 @@ You can also access Ente Photos directly in your browser without installing anytEnte Photos also offers a command-line interface (CLI) for advanced users and automation. The CLI is particularly useful for server environments, scheduled backups, and scripting workflows.-Learn more in the [CLI feature guide](/photos/features/utilities/cli).+Learn more in [Install Ente CLI](/cli/install).## Next stepsdiff --git a/docs/docs/photos/migration/export/index.md b/docs/docs/photos/migration/export/index.mdindex 859b26cb69..bf4618a3ca 100644--- a/docs/docs/photos/migration/export/index.md+++ b/docs/docs/photos/migration/export/index.md@@ -61,4 +61,4 @@ You can switch on the toggle to **Sync continuously** to eliminate manual exportIf you run into any issues during your data export, please reach out to [[email protected]](mailto:[email protected]) and we will be happy to help you!-Note that we also provide a [CLI tool](https://github.com/ente/ente/tree/main/cli#export) to export your data. You can find more information about the export in the [export FAQ](/photos/faq/advanced-features).+Note that we also provide a [CLI tool](/cli/photos) to export your data. You can find more information about the export in the [export FAQ](/photos/faq/advanced-features).diff --git a/docs/docs/self-hosting/administration/cli.md b/docs/docs/self-hosting/administration/cli.mdindex 600bda559b..21d41338b4 100644--- a/docs/docs/self-hosting/administration/cli.md+++ b/docs/docs/self-hosting/administration/cli.md@@ -5,6 +5,8 @@ description: Guide to configuring Ente CLI for Self Hosted Instance# Ente CLI for self-hosted instance+This page covers the previous CLI. For the current CLI, see [Administration](/cli/admin). To switch versions, follow [Migration](/cli/migration).+If you are self-hosting, you can configure Ente CLI to export data & perform basic administrative actions.> [!TIP]@@ -58,7 +60,7 @@ You can use `ente admin update-subscription` to increase storage quota and accouFor infinite storage and validity, use the following command:```sh-ente admin update-subscription -a <admin-user-mail> -u <user-email-to-update> --no-limit+ente admin update-subscription -a <admin-user-mail> -u <user-email-to-update> --no-limit True# Set a limitente admin update-subscription -a <admin-user-mail> -u <user-email-to-update> --no-limit Falsediff --git a/docs/docs/self-hosting/administration/users.md b/docs/docs/self-hosting/administration/users.mdindex 372f3d68a0..227ae8e011 100644--- a/docs/docs/self-hosting/administration/users.md+++ b/docs/docs/self-hosting/administration/users.md@@ -68,7 +68,7 @@ The administrator users have to be explicitly whitelisted in `museum.yaml`. You## Increase storage and account validity-You can use Ente CLI for increasing storage quota and account validity for users on your instance. Check this guide for more [information](/self-hosting/administration/cli#step-4-increase-storage-and-account-validity)+Use Ente CLI to change storage quotas and account validity for users on your instance. Learn more in [Administration](/cli/admin#change-a-free-subscription).## Handle user verification codesdiff --git a/docs/docs/self-hosting/development/building-from-source.md b/docs/docs/self-hosting/development/building-from-source.mdindex 43512214bf..0d6f8baa91 100644--- a/docs/docs/self-hosting/development/building-from-source.md+++ b/docs/docs/self-hosting/development/building-from-source.md@@ -42,7 +42,7 @@ Then the toolchains:| -------- | ---------------------------------------------------- | -------------------- || Rust | [rustup](https://www.rust-lang.org/tools/install) | `rust/`, web, mobile || Node | `brew install node` | web, desktop, docs |-| Go | `brew install go` | server, CLI |+| Go | `brew install go` | server, previous CLI || Flutter | [Docs](https://flutter.dev/docs/get-started/install) | mobile |Node and Go are one `brew` command each:diff --git a/docs/docs/self-hosting/guides/tailscale.md b/docs/docs/self-hosting/guides/tailscale.mdindex 6abf1495e7..31b2392f47 100644--- a/docs/docs/self-hosting/guides/tailscale.md+++ b/docs/docs/self-hosting/guides/tailscale.md@@ -178,14 +178,10 @@ services:environment:# Pass-in the config to connect to the DB and MinIOENTE_CREDENTIALS_FILE: /credentials.yaml- # ENTE_CLI_SECRETS_PATH: /cli-data/secret.txt- # ENTE_CLI_CONFIG_PATH: /cli-data/volumes:- /home/ubuntu/docker/ente/custom-logs:/var/logs- /home/ubuntu/docker/ente/museum.yaml:/museum.yaml:ro- /home/ubuntu/docker/ente/scripts/compose/credentials.yaml:/credentials.yaml:ro- #- /home/ubuntu/docker/ente/cli-data:/cli-data- #- /home/ubuntu/docker/ente/exports/ente-photos:/exports- /home/ubuntu/docker/ente/data:/data:ronetworks:- ente@@ -272,30 +268,19 @@ networks:> Thats it. Run `docker compose up -d`. Wait until every container becomes healthy. Open a web browser. Make sure tailscale is installed on the machine. Visit https://ente.xyz.ts.net/ping. It will pong. All good if you see it. First time it will take minute or two to get SSL cert. Downnload Desktop or mobile app. Tap 7 time on the screen, which will prompt developer mode. Add https://ente.xyz.ts.net. Add new user. When asked for OTP, go to your linux terminal and run `docker logs ente-museum-1`. Search for userauth. Feed the six digit and Done.-> For getting 100TB (limitless) storage, install ente-cli for windows. Extract it and add folder. Name it **export**. Create a `.ente` folder in your user profile directory and add `%USERPROFILE%\.ente\config.yaml` with the following:+To increase storage, [install Ente CLI](/cli/install) and log in to your server. In PowerShell, from the folder containing `ente.exe`:+```powershell+.\ente.exe account login --account home-server --app photos --host https://ente.xyz.ts.net+.\ente.exe account list```-endpoint:- api: "https://ente.xyz.ts.net"- accounts: "http://localhost:3001"-log: false-```--Right-Click in the directory where you have extracted ente-cli. Select `open in terminal`. Run--```-.\ente.exe account bob # change bob to yours-```--Hit Enter twice. For export directory, just write export, as you already created the **export** folder earlier. **Write email. The one which is already used before when creating ente account in ente desktop app.** Type the same password used before for the account. Run+Use the email and password of the account you created in Ente Photos. Copy its ID from the account list, [whitelist it as an administrator](/self-hosting/administration/users#whitelist-admins), and restart Museum. Then run:+```powershell+.\ente.exe admin user update-subscription [email protected] --no-limit --account home-server```-.\ente.ext account list-```--This will list all account details. Copy Acount ID.-> Navigate to museum.yaml file. `cd docker/ente`. Run `sudo nano museum.yaml` and add the account ID under Admins. Delete any previous entries. Restart ente-museum-1 container from linux terminal. Run `docker restart ente-museum-1`. All well, now you will have 100TB storage. Repeat if for any other accounts you want to give unlimited storage access.+Replace `[email protected]` with the account whose storage you want to change. Confirm the displayed changes. Learn more in [Administration](/cli/admin#change-a-free-subscription).> **Credits:** [A4alli](https://github.com/A4alli)diff --git a/docs/docs/self-hosting/guides/windows.md b/docs/docs/self-hosting/guides/windows.mdindex d0734861ca..3361346ccc 100644--- a/docs/docs/self-hosting/guides/windows.md+++ b/docs/docs/self-hosting/guides/windows.md@@ -265,7 +265,7 @@ Follow https://ente.com/help/self-hosting/installation/post-install and enjoy thmc admin config set admin api cors\_allow\_origin="\*"```3. Restart your minio container and you should be ready to upload!-- In case you missed it, use the ente CLI to increase your storage limits: https://ente.com/help/self-hosting/administration/cli#step-4-increase-storage-and-account-validity+- Use Ente CLI to increase your storage limits. Learn more in [Administration](/cli/admin#change-a-free-subscription).## Next stepsdiff --git a/docs/docs/self-hosting/installation/post-install/index.md b/docs/docs/self-hosting/installation/post-install/index.mdindex ee6a138b46..c29b53551c 100644--- a/docs/docs/self-hosting/installation/post-install/index.md+++ b/docs/docs/self-hosting/installation/post-install/index.md@@ -181,9 +181,13 @@ apps](web-dev-settings.png){width=400px}## Step 7: Configure Ente CLI-You can download Ente CLI from [here](https://github.com/ente/ente/releases?q=tag%3Acli).+[Install Ente CLI](/cli/install), then log in with your server’s API URL:-Check our [documentation](/self-hosting/administration/cli) on how to use Ente CLI for managing self-hosted instances.+```sh+ente account login --account home-server --app photos --host https://api.example.org+```++Learn more about managing users in [Administration](/cli/admin).> [!NOTE]>diff --git a/docs/docs/self-hosting/troubleshooting/cli.md b/docs/docs/self-hosting/troubleshooting/cli.mdindex 878f30ab78..e14cc7bb50 100644--- a/docs/docs/self-hosting/troubleshooting/cli.md+++ b/docs/docs/self-hosting/troubleshooting/cli.md@@ -5,6 +5,8 @@ description: A quick hotfix for keyring errors while running Ente CLI.# Ente CLI+This page covers the previous CLI. For the current CLI, see [Troubleshooting](/cli/troubleshooting). To switch versions, follow [Migration](/cli/migration).+## SecretsEnte CLI makes use of your system keyring for storing sensitive information such as passwords.diff --git a/rust/apps/cli/src/args.rs b/rust/apps/cli/src/args.rsindex b0d10e134c..b7bf32c94e 100644--- a/rust/apps/cli/src/args.rs+++ b/rust/apps/cli/src/args.rs@@ -5,7 +5,12 @@ use clap_complete::Shell;use serde::{Deserialize, Serialize};#[derive(Parser)]-#[command(name = "ente", version, about = "Ente client for terminals and agents")]+#[command(+ name = "ente",+ version,+ about = "Ente client for terminals and agents",+ after_help = "Documentation: https://ente.com/help/cli/"+)]pub struct Cli {#[command(flatten, next_help_heading = "Global options")]pub options: Options,