ente/cli
2024-05-03 09:42:17 +05:30
..
cmd [cli] Add API to delete-user 2024-03-14 16:18:08 +05:30
docs [cli] Generate docs 2024-03-14 16:18:37 +05:30
internal [cli] Fix handling of delete file with stale colleciton entry (#1259) 2024-03-30 14:14:03 +05:30
pkg [cli] Fix handling of delete file with stale colleciton entry (#1259) 2024-03-30 14:14:03 +05:30
utils [cli] Add admin API to bump up storage for free users 2024-03-13 02:03:44 +05:30
.gitattributes [cli] Mark docs/generated as generated for Github 2024-03-14 16:20:47 +05:30
.gitignore Move into cli/ 2024-03-01 12:39:01 +05:30
config.yaml.example [cli] By default, update sub to high storage & expiry 2024-03-13 02:03:44 +05:30
docker-compose.yml Move into cli/ 2024-03-01 12:39:01 +05:30
Dockerfile Move into cli/ 2024-03-01 12:39:01 +05:30
Dockerfile-x86 Move into cli/ 2024-03-01 12:39:01 +05:30
go.mod Add cli generated docs inside docs/generated 2024-03-13 02:03:44 +05:30
go.sum Add cli generated docs inside docs/generated 2024-03-13 02:03:44 +05:30
main.go [cli] Improve logging for decryption error (#1242) 2024-03-29 11:08:45 +05:30
README.md Add a notice about ente account add 2024-05-03 09:42:17 +05:30
release.sh [cli] Pick version from the github tag 2024-03-13 11:43:19 +05:30

Ente CLI

The Ente CLI is a Command Line Utility for exporting data from Ente. It also does a few more things, for example, you can use it to decrypting the export from Ente Auth.

Install

The easiest way is to download a pre-built binary from the GitHub releases.

You can also build these binaries yourself

./release.sh

Or you can build from source

 go build -o "bin/ente" main.go

The generated binaries are standalone, static binaries with no dependencies. You can run them directly, or put them somewhere in your PATH.

There is also an option to use Docker.

Usage

Run the help command to see all available commands.

ente --help

Accounts

If you wish, you can add multiple accounts (your own and that of your family members) and export all data using this tool.

Add an account

ente account add

Note

ente account add does not create new accounts, it just adds pre-existing accounts to the list of accounts that the CLI knows about so that you can use them for other actions.

List accounts

ente account list

Change export directory

ente account update --email email@domain.com --dir ~/photos

Export

Start export

ente export

CLI Docs

You can view more cli documents at docs. To update the docs, run the following command:

go run main.go docs

Docker

If you fancy Docker, you can also run the CLI within a container.

Configure

Modify the docker-compose.yml and add volume. cli-data volume is mandatory, you can add more volumes for your export directory.

Build the docker image

docker build -t ente:latest .

Note that BuildKit is needed to build this image. If you face this issue, a quick fix is to add DOCKER_BUILDKIT=1 in front of the build command.

Start the container in detached mode

docker-compose up -d

exec into the container

docker-compose exec ente /bin/sh

Directly executing commands

docker run -it --rm ente:latest ls