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 6070bf3cf4 into 6033d6bbb3

Browse source
This commit is contained in:
Paul Mairo 2025-01-08 22:35:07 +01:00 • committed by GitHub
commit ed63e2b274
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 20 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
README.md
View file

@ -1,10 +1,10 @@
# go-passbolt-cli # go-passbolt-cli
A CLI tool to interact with Passbolt, an 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 Go Module](https://github.com/passbolt/go-passbolt) 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 interest 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
# Install # Install
## Via Repository (Prefered): ## Via Repository (Prefered):
@ -28,7 +28,7 @@ Note: tab completion and manpages will need to be installed manually.
Note: this will install the binary as go-passbolt-cli, also tab completion and manpages will be missing. Note: this will install the binary as go-passbolt-cli, also tab completion and manpages will be missing.
# Getting Started # Getting Started
First you need to Setup basic information: the Server Address, your Private Key and your Password. First, you need to set up basic information: the Server Address, your Private Key, and your Password.
You have these options: You have these options:
- Save it in the config file using - Save it in the config file using
``` ```
@ -43,23 +43,23 @@ passbolt configure --serverAddress https://passbolt.example.org --userPassword '
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 permanently this ways - MFA settings can also be saved permanently these ways
# Usage # Usage
Generally the Structure of Commands is like this: Generally, the Structure of Commands is like this:
```bash ```bash
passbolt action entity [arguments] passbolt action entity [arguments]
``` ```
Action is the Action you want to perform like Creating, Updating or Deleting an 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 an 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 referred to as a Resource.
To Create a Resource you can do this, it will return the ID of the newly created Resource: To Create a Resource, you can do this. It will return the ID of the newly created Resource:
```bash ```bash
passbolt create resource --name "Test Resource" --password "Strong Password" passbolt create resource --name "Test Resource" --password "Strong Password"
``` ```
@ -68,10 +68,10 @@ You can then list all users:
```bash ```bash
passbolt list user passbolt list user
``` ```
Note: you can adjust which columns should be listed using the flag `--column` or its short from `-c`, if you want multiple column then you need to specify this flag multiple times. Note: you can adjust which columns should be listed using the flag `--column` or its short from `-c`, if you want multiple columns then you need to specify this flag multiple times.
For sharing we will need to know how we want to share, for that there are these Permission Types: For sharing, we will need to know how we want to share. For that, there are these Permission Types:
| Code | Meaning | | Code | Meaning |
| --- | --- | | --- | --- |
@ -80,32 +80,32 @@ For sharing we will need to know how we want to share, for that there are these
| `15` | "Owner" | | `15` | "Owner" |
| `-1` | Delete existing permission | | `-1` | Delete existing permission |
Now that we have a Resource ID, know the ID's of other Users and about know about Permission Types, we can share the Resource with them: Now that we have a Resource ID, know the ID's of other Users and know about Permission Types, we can share the Resource with them:
```bash ```bash
passbolt share resource --id id_of_resource_to_share --type type_of_permission --user id_of_user_to_share_with passbolt share resource --id id_of_resource_to_share --type type_of_permission --user id_of_user_to_share_with
``` ```
Note: you can supply the the users argument multiple times to share with multiple users Note: you can supply the `user` argument multiple times to share with multiple users
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 multiple modes for MFA: `none`, `interactive-totp` and `noninteractive-totp`. You can also set up MFA using the configuration subcommand. Only TOTP is supported, and there are multiple modes for MFA: `none`, `interactive-totp`, and `noninteractive-totp`.
| Mode | Description | | Mode | Description |
| --- | --- | | --- | --- |
|`none`|just errors if challenged for MFA. |`none`|just errors if challenged for MFA.
|`interactive-totp` | prompts for interactive entry of TOTP Codes. |`interactive-totp` | prompts for interactive entry of TOTP Codes.
|`noninteractive-totp` | automatically generates TOTP Codes when challenged, it requires the `mfaTotpToken` flag to be set to your totp Secret, you can configure the behavior using the `mfaDelay`, `mfaRetrys` and `mfaTotpOffset` flags |`noninteractive-totp` | automatically generates TOTP Codes when challenged. It requires the `mfaTotpToken` flag to be set to your totp Secret, you can configure the behavior using the `mfaDelay`, `mfaRetrys` and `mfaTotpOffset` flags
# 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
# Scripting # Scripting
For Scripting we have a -j or --json flag to convert the Output for the create, get and list commands to JSON for easier Parsing in Scripts. For Scripting, we have a -j or --json flag to convert the Output for the create, get and list commands to JSON for easier Parsing in Scripts.
Note: The JSON Output does not cover Error Messages, you can detect Errors by checking if the Exitcode is not 0 Note: The JSON Output does not cover Error Messages. You can detect Errors by checking if the Exitcode is not 0
# Documentation # Documentation
Usage for all Subcommands is [here](https://github.com/passbolt/go-passbolt-cli/wiki/passbolt). Usage for all Subcommands is [here](https://github.com/passbolt/go-passbolt-cli/wiki/passbolt).
And is also available via `man passbolt` It is also available via `man passbolt`