You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|rm \| remove | Removes an existing vault | 1 | Local |
46
+
|ls \| list| Lists all existing vaults | 1 | Local |
47
+
| rename | Renames an existing vault | 1 | Local |
48
+
| stats | Gets the stats of an existing vault | 1 | Local |
49
+
| share | Shares vaults with a gestalt | 1 | Local |
50
+
| unshare | Unshares vaults with a gestalt | 1 | Local |
51
+
| permissions | Gets the permissions for a vault | 1 | Local |
52
+
| pull | Pulls a vault from another node | 1 | Agent-Agent |
53
+
| scan | Lists the vaults of another node | 1 | Agent-Agent |
54
+
| clone | Clones a vault from another node | 1 | Agent-Agent |
55
55
56
56
### Secrets
57
57
58
58
The secrets subcommand will deal with CRUD (Create, read, update and delete) operations on secrets within a Polykey vault.
59
59
60
60
As secrets subcommands are performed within a single vault, paths are specified using the following notation `<vaultName>:<secretPath>`. As each vault maintains separate filesystems, secrets cannot be transferred across vaults.
|rm \| remove | Removes an existing secret| 1 | Local |
66
+
|ed \| edit | Edits an existing secret or creates one if it doesn't exist| 1 | Local |
67
+
|cat| Gets the contents of one or more secrets | 1 | Local |
68
+
|ls \| list | Lists the secrets within an existing directory | 1 | Local |
69
+
| mkdir | Makes a directory inside an existing vault| 1 | Local |
70
+
| dir | Adds a directory of secrets to an existing vault| 1 | Local |
71
+
| rename | Renames an existing secret| 1 | Local |
72
+
|write | Updates an existing secret with new content taken from standard input| 1 | Local |
73
+
| env | Injects existing secrets into an environment| 2 | Local |
74
74
75
75
### Keys
76
76
@@ -83,7 +83,7 @@ Encryption using the root keypair has a size limit depending on the size of the
83
83
For signature and verification using the root keypair, the data and signature will be input and output separately. In the future, this will be done using a specific file format which allows the signature and data to be compiled into one file.
| send | Sends a notification to another node | 1 | Agent-Agent |
135
137
| read | Displays notifications and marks them as "read" | 1 | Local |
136
138
| clear | Clears all read and unread notifications | 1 | Local |
@@ -139,10 +141,10 @@ The identities subcommand allows control over the node's identity and its links
139
141
140
142
- Toggles should be `-f``-v` flags that when used are `true` and when not used are `false`. These can be joined up together like `-fv`, but this may be confusing with the multiword options, and in which case I usually don't use the joined up versions. Flags should be sparing, users should not need to remember every flag they need to do something.
141
143
- Options should ideally be optional `--key value` and `-k value`. In some cases they represent key-value parameters which are not optional. Make sure that multi-word options are like `--multi-word` and their short form is `-mw`.
142
-
- Parameters should be positional so `pk subcommand param1 param2`, in that case they are usually not optional and are required, it is possible to have arbitrary arity of parameters so you can have 1, or many.
143
-
- Exception is `pk subcommand -k value -k2 value -k3 value`, which is a key value parameters, this would not be optional, but in many cases if the commands are designed well, you should be able to have all values as parameters.
144
+
- Parameters should be positional so `polykey subcommand param1 param2`, in that case they are usually not optional and are required, it is possible to have arbitrary arity of parameters so you can have 1, or many.
145
+
- Exception is `polykey subcommand -k value -k2 value -k3 value`, which is a key value parameters, this would not be optional, but in many cases if the commands are designed well, you should be able to have all values as parameters.
144
146
145
-
Make sure you're using the output formatting functions in the `src/bin/utils.ts` (or at least that's where I had them last). This ensures you have a consistent set outputs, whether it is a list, table, json or otherwise. We can have `-f` to indicate different output formats for these.
147
+
Make sure you're using the output formatting functions in the `src/bin/utils.ts`. This ensures you have a consistent set outputs, whether it is a list, table, json or otherwise. We can have `-f` to indicate different output formats for these.
146
148
147
149
And for testing, try to use the `main` exported function, but I think as you said on slack there are new methods that make it easier to test these that might have been created by @DrFacepalm or @scottmmorris.
0 commit comments