diff --git a/README.md b/README.md index e005a8dd9..b76ad24d9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# cli for exporting ente.io data +# Command Line Utility for exporting data from [Ente](https://ente.io) ## Install @@ -7,70 +7,80 @@ You can either download the binary from the [release page](https://github.com/en ### Build from source ```shell - go build -o "bin/ente-cli" main.go + go build -o "bin/ente" main.go ``` ### Getting Started Run the help command to see all available commands. ```shell -ente-cli --help +ente --help ``` #### Accounts -If you wish, you can add multiple accounts (your own and your family members) and export all using this tool. -* Add an account - ```shell - ente-cli account add - ``` +If you wish, you can add multiple accounts (your own and that of your family members) and export all data using this tool. -* List accounts - ```shell - ente-cli account list - ``` +##### Add an account +```shell +ente account add +``` + +##### List accounts +```shell +ente account list +``` -* Change export directory - ```shell - ente-cli account update --email yourEmail@example.com --dir ~/photos - ``` +##### Change export directory +```shell +ente account update --email email@domain.com --dir ~/photos +``` ### Export -* Start export - ```shell - ente-cli export - ``` +##### Start export +```shell +ente export +``` + +--- ## 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 - ```shell - docker build -t ente-cli:latest . - ``` - * Start the container in detached mode - ```bash - docker-compose up -d - ``` -exec into the container + +Build the docker image ```shell - docker-compose exec ente-cli /bin/sh +docker build -t ente:latest . +``` + +Start the container in detached mode +```bash +docker-compose up -d +``` + +`exec` into the container +```shell +docker-compose exec ente /bin/sh ``` -#### How to directly execute the command +#### Directly executing commands - ```shell - docker run -it --rm ente-cli:latest ls - ``` +```shell +docker run -it --rm ente:latest ls +``` +--- ## Releases Run the release script to build the binary and run it. ```shell - ./release.sh +./release.sh ```