nc_password_client/README.md

64 lines
2.2 KiB
Markdown
Raw Normal View History

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-12 07:47:22 +01:00
Not necessary if you use the Bash script because it will create a virtual environment for it, and do the installation.
2024-11-10 11:53:00 +01:00
```bash
sudo python3 setup.py install
```
2024-11-12 07:44:35 +01:00
### Windows (from PowerShell untested)
2024-11-10 11:53:00 +01:00
```powershell
& $(where.exe python).split()[0] setup.py install
```
## 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
-t, --timeout INTEGER Nextcloud user's end-to-end encryption
password
-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
migrate-pass Migrate password store passwords to Nextcloud...
remove-duplicates Remove duplicate passwords
show Show a single password
2024-11-10 11:53:00 +01:00
```