speatzle/go-passbolt-cli
1
0
Fork 0
mirror of https://github.com/passbolt/go-passbolt-cli.git synced 2025-05-12 02:58:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #13 from bersace/patch-1

Browse source 
Lint and fix typos in README
This commit is contained in:
Samuel Lorch 2022-08-21 13:24:07 +02:00 • committed by GitHub
commit 0804a1d9b1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,7 +1,7 @@
# go-passbolt-cli # go-passbolt-cli
A CLI tool to interact with Passbolt, a Open source Password Manager for Teams. A CLI tool to interact with Passbolt, an Open source Password Manager for teams.
If you want to do something more complicated: [this](https://github.com/passbolt/go-passbolt) Go Module to Interact with Passbolt from Go might intrest you. If you want to do something more complicated: [this Go Module](https://github.com/passbolt/go-passbolt) to Interact with Passbolt from Go might intrest you.
Disclaimer: This project is community driven and not associated with Passbolt SA Disclaimer: This project is community driven and not associated with Passbolt SA
@ -30,14 +30,14 @@ or
``` ```
passbolt configure --serverAddress https://passbolt.example.org --userPassword '1234' --userPrivateKey '-----BEGIN PGP PRIVATE KEY BLOCK-----' passbolt configure --serverAddress https://passbolt.example.org --userPassword '1234' --userPrivateKey '-----BEGIN PGP PRIVATE KEY BLOCK-----'
``` ```
- Setup Enviroment Variables - Setup Environment Variables
- Provide the Flags manually every time - Provide the Flags manually every time
Notes: Notes:
- You can set the Private Key using the flags `--userPrivateKey` or `--userPrivateKeyFile` where `--userPrivateKey` takes the actual private key and `--userPrivateKeyFile` loads the content of a file as the PrivateKey, `--userPrivateKeyFile` overwrites the value of `--userPrivateKey`. - You can set the Private Key using the flags `--userPrivateKey` or `--userPrivateKeyFile` where `--userPrivateKey` takes the actual private key and `--userPrivateKeyFile` loads the content of a file as the PrivateKey, `--userPrivateKeyFile` overwrites the value of `--userPrivateKey`.
- You can also just store the serverAddress and your Private Key, if your Password is not set it will prompt you for it every time. - You can also just store the serverAddress and your Private Key, if your Password is not set it will prompt you for it every time.
- Passwordless PrivateKeys are unsupported - Passwordless PrivateKeys are unsupported
- MFA settings can also be save permenantly this ways - MFA settings can also be save permanently this ways
# Usage # Usage
@ -46,8 +46,8 @@ Generally the Structure of Commands is like this:
go-passbolt-cli action entity [arguments] go-passbolt-cli action entity [arguments]
``` ```
Action is the Action you want to perform like Creating, Updating or Deleting a Entity. Action is the Action you want to perform like Creating, Updating or Deleting an Entity.
Entity is a Resource(Password), Folder, User or Group that you want to apply a action to. Entity is a Resource(Password), Folder, User or Group that you want to apply an action to.
In Passbolt a Password is usually revert to as a Resource. In Passbolt a Password is usually revert to as a Resource.
@ -81,7 +81,7 @@ Note: you can supply the the users argument multiple times to share with multipl
For sharing with groups the `--group` argument exists. For sharing with groups the `--group` argument exists.
# MFA # MFA
you can setup MFA also using the configuration sub command, only TOTP is supported, there are mulitple modes for MFA: `none`, `interactive-totp` and `noninteractive-totp`. You can setup MFA also using the configuration sub command, only TOTP is supported, there are multiple modes for MFA: `none`, `interactive-totp` and `noninteractive-totp`.
| Mode | Description | | Mode | Description |
| --- | --- | | --- | --- |
|`none`|just errors if challanged for MFA. |`none`|just errors if challanged for MFA.
@ -90,7 +90,7 @@ you can setup MFA also using the configuration sub command, only TOTP is support
# Server Verification # Server Verification
to enable Server Verification you need to run `passbolt verify` once, after that the server will always be verified if the same config is used To enable Server Verification you need to run `passbolt verify` once, after that the server will always be verified if the same config is used
# Documentation # Documentation
Usage for all Subcommands is [here](https://github.com/passbolt/go-passbolt-cli/wiki/go-passbolt-cli). Usage for all Subcommands is [here](https://github.com/passbolt/go-passbolt-cli/wiki/go-passbolt-cli).