nc_password_client/README.md

# nc_password_client

Command line interface (CLI) for the Nextcloud Passwords app.
Manage your password and import them from [Password Store](https://www.passwordstore.org/).

## Requirements

See requirements.txt

To cache the passwords locally the application uses the system keyring to store a random password that encrypts the cache file.

Tested in Ubuntu 24.10 with Gnome 47 and Nextcloud 30.0.2. But should work with similar setups. Create an [issue](https://repos.susurrando.com/adelgado/nc_password_client/issues) if you want me to test it in a different setup, but I can promise much.

## Installation

### Linux

To install for example in your ~/.local/bin folder:
```bash
./install.sh --destination ~/.local/bin
```

To install system-wide:
```bash
sudo ./install.sh --destination /usr/local/bin
```

Change your configuration file in "${HOME}/.config/nc_password_client.conf" (see the example in the config folder).

## Usage

Usage: nc_password_client.sh [OPTIONS] COMMAND [ARGS]...

### Options:
| option                    | parameters                                 |                                 description                     |
| ------------------------- | ------------------------------------------ | --------------------------------------------------------------- |
|  -d, --debug-level        | [CRITICAL|ERROR|WARNING|INFO|DEBUG|NOTSET] | Set the debug level for the standard output.                    |
|  -f, --output-format      | [json|yaml|plain]                          |  Set the output format.|
|  -l, --log-file           | TEXT                                       |           File to store all debug messages.                     |
|  -H, --host               | TEXT                                       |                Nextcloud host name  [required]                  |
|  -u, --user               | TEXT                                       |               Nextcloud user name  [required]                   |
|  -a, --api-token          | TEXT                                       |           Nextcloud user's application token [required]         |
|  -p, --cse-password       | TEXT                                       |        Nextcloud user's end-to-end encryption password          |
|  -t, --timeout            | INTEGER                                    |          Timeout for HTTPS requests                             |
|  -c, --cache-duration     | INTEGER                                    |   Number of seconds to hold the list of passwords               |
|  -P, --https-proxy        | TEXT                                       |          HTTPS proxy to use to connect to the Nextcloud instance|
|  -F, --field-replacements | TEXT                                       |  Pairs of field names to be replaced separated by a : (colon). Like: -F login:username |
|  --config                 | FILE                                       |                  Read configuration from FILE.                  |
|  --help                   |                                            |                         Show this message and exit.             |

### Commands:
| command                  | description                                    |
| ------------------------ | ---------------------------------------------- |
| create-password          |Create a password                               |
| create-passwords-folder  |Create a password folder                        |
| delete-all-passwords     |Delete all passwords                            |
| delete-password          |Delete a password                               |
| delete-passwords-folder  |Delete a password folder                        |
| import-csv               | Import passwords stored in a CSV file to Nextcloud Passwords |
| list-passwords-folders   |List all password folders                       |
| ls                       |List all password                               |
| migrate-pass             |Migrate Password Store passwords to Nextcloud...|
| remove-duplicates        |Remove duplicate passwords                      |
| search                   | Search for a password (or passwords) that...   |
| show                     |Show a single password                          |

Use --help after the command to get more details of it's options