2024-11-10 11:53:00 +01:00
|
|
|
# nc_password_client
|
|
|
|
|
2024-11-12 07:47:22 +01:00
|
|
|
Command line client (CLI) for the Nextcloud Passwords app.
|
|
|
|
Manage your password and import them from [Password Store](https://www.passwordstore.org/).
|
|
|
|
|
2024-11-10 11:53:00 +01:00
|
|
|
## Requirements
|
|
|
|
|
2024-11-12 07:47:22 +01:00
|
|
|
See requirements.txt
|
|
|
|
|
2024-11-10 11:53:00 +01:00
|
|
|
## Installation
|
|
|
|
|
|
|
|
### Linux
|
|
|
|
|
2024-11-16 21:54:10 +01:00
|
|
|
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
|
2024-11-10 11:53:00 +01:00
|
|
|
```
|
|
|
|
|
2024-11-16 22:06:35 +01:00
|
|
|
Change your configuration file in "${HOME}/.config/nc_password_client.conf" (see the example in the config folder).
|
|
|
|
|
2024-11-10 11:53:00 +01:00
|
|
|
## Usage
|
|
|
|
|
|
|
|
```bash
|
2024-11-12 07:47:22 +01:00
|
|
|
Usage: nc_password_client.sh [OPTIONS] COMMAND [ARGS]...
|
2024-11-12 07:44:35 +01:00
|
|
|
|
|
|
|
Client function to pass context
|
|
|
|
|
|
|
|
Options:
|
|
|
|
-d, --debug-level [CRITICAL|ERROR|WARNING|INFO|DEBUG|NOTSET]
|
|
|
|
Set the debug level for the standard output.
|
|
|
|
-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
|
2024-11-16 22:11:54 +01:00
|
|
|
-t, --timeout INTEGER Timeout for HTTPS requests
|
2024-11-12 07:44:35 +01:00
|
|
|
-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
|
|
|
|
--config FILE Read configuration from FILE.
|
|
|
|
--help Show this message and exit.
|
|
|
|
|
|
|
|
Commands:
|
|
|
|
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
|
|
|
|
list-passwords-folders List all password folders
|
|
|
|
ls List all password
|
2024-11-12 09:43:04 +01:00
|
|
|
migrate-pass Migrate Password Store passwords to Nextcloud...
|
2024-11-12 07:44:35 +01:00
|
|
|
remove-duplicates Remove duplicate passwords
|
|
|
|
show Show a single password
|
2024-11-10 11:53:00 +01:00
|
|
|
```
|