keypin 0.6.0 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -101,6 +101,7 @@ See [Import](https://github.com/caiopizzol/keypin/blob/main/docs/import.md).
101
101
  keypin init [folder] # register a project and write a keypin.toml
102
102
  keypin unregister [folder] # stop listing a project (its keypin.toml stays)
103
103
  keypin status [--json] # every key, when it's due, and any problem
104
+ keypin check [folder] # check the map, vault items and logins, and write nothing
104
105
  keypin discover [folder] # every key name a project uses, where it's set, and a draft map
105
106
  # (--write saves the draft as keypin.toml and registers the project)
106
107
  keypin import <env-file> --vault <vault>
@@ -108,9 +109,26 @@ keypin import <env-file> --vault <vault>
108
109
  keypin run -- <command> # run a command with the project's dev keys (--env for another)
109
110
  keypin publish <VARIABLE> # check each destination's account, then write the key
110
111
  keypin publish --all # publish every key, with one plan and one approval
112
+ keypin publish --all --plan # show that plan without a terminal, and write nothing
111
113
  keypin rotate <VARIABLE> # replace a Cloudflare API token, then revoke the old one
112
114
  ```
113
115
 
116
+ ### Check a setup
117
+
118
+ `keypin check` checks a project before you publish, and changes nothing:
119
+
120
+ - the map parses;
121
+ - each `op://` reference's item and field exist, including a `rotate` section's admin item;
122
+ - for each destination, the login keypin would use, who it acts as, the account it reaches, and how to fix a
123
+ mismatch.
124
+
125
+ It reads each value to check its field, so 1Password asks you to approve it, and it never prints a value. It
126
+ also notes a login stored in plain text, such as wrangler's. It exits 0 when everything checks out, and 1 with
127
+ one line per problem. `--json` prints the same as JSON.
128
+
129
+ Add `--plan` to `publish` or `rotate` to see the plan without a terminal. It changes nothing, and prints the
130
+ command that does.
131
+
114
132
  `import`, `publish` and `rotate` show a plan and wait for you to type `yes`. `--yes` approves `import`, which only
115
133
  creates new items. For `publish` and `rotate`, it skips that only for routine updates: it never approves a first
116
134
  write, a changed account or vault item, or a revoke. `keypin --help` lists the exit codes.