sefy-cli 0.4.0 → 0.6.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.
Files changed (2) hide show
  1. package/README.md +21 -11
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -151,17 +151,25 @@ named `sefy-plugin-*`, found in sefy's data directory or on `PATH`. sefy knows
151
151
  nothing about git, FTP or any cloud drive - it asks a plugin what it can do and
152
152
  what happened.
153
153
 
154
- `sefy-plugin-github` ships alongside the CLI and keeps the vault in a git
155
- repository - point `SEFY_GITHUB_REPO` at one and `sefy sync` does the rest.
156
- Authentication is whatever git already does on the machine, so no token is
157
- stored anywhere.
154
+ Two transports ship alongside the CLI, and neither stores a credential of its
155
+ own - each authenticates the way the machine already does:
156
+
157
+ - **github** keeps the vault in a git repository. Point `SEFY_GITHUB_REPO` at
158
+ one; version history comes free with it.
159
+ - **sftp** keeps it on a server you control, over OpenSSH. Point
160
+ `SEFY_SFTP_DESTINATION` at `you@server:/path`; nothing lands there but the
161
+ blob.
158
162
 
159
163
  ```
160
164
  $ sefy plugin list
161
165
  future 9.0.0 unusable: it speaks protocol 99 and this build speaks 1
162
- github 0.4.0 pull, push
166
+ github 0.6.0 pull, push
167
+ sftp 0.6.0 pull, push
163
168
  ```
164
169
 
170
+ With more than one installed, sefy asks which rather than choosing where your
171
+ vault goes: `sefy sync --transport sftp`, or `SEFY_TRANSPORT=sftp` once.
172
+
165
173
  A transport is handed the **path of the sealed file** and nothing else - no
166
174
  master password, no key, no item. What it carries is what anyone would find on
167
175
  your disk: a blob it cannot read. That is also why a plugin cannot merge: it
@@ -208,8 +216,8 @@ curl -fsSL https://raw.githubusercontent.com/lacodda/sefy/main/tools/install.sh
208
216
 
209
217
  On Windows use the PowerShell line above: `install.sh` carries the macOS and Linux builds only, and run from Git Bash it stops with a pointer back here.
210
218
 
211
- **cargo** - `cargo install sefy` (and `cargo install sefy-plugin-github` for the
212
- git transport)
219
+ **cargo** - `cargo install sefy`, plus `cargo install sefy-plugin-github` or
220
+ `sefy-plugin-sftp` for a transport
213
221
 
214
222
  **npm** - `npm install -g sefy-cli`
215
223
 
@@ -237,10 +245,12 @@ The database inside the ciphertext is versioned separately, and it does move:
237
245
  from 0.1.x opens, is migrated on the way in, and is still readable by 0.1.x
238
246
  afterwards - the file on disk did not change shape.
239
247
 
240
- The **plugin protocol is at version 1** as of 0.3.0, and 0.4.0 put it to work
241
- without changing it. Optional fields may be added to the manifest without
242
- breaking a plugin that predates them; changing what an existing field means
243
- would arrive as version 2, with both accepted for a time.
248
+ The **plugin protocol is at version 1** as of 0.3.0. 0.4.0 put it to work and
249
+ 0.5.0 added a second transport of a different shape without changing a field of
250
+ it, which is the evidence that it was not built around the first one. Optional
251
+ fields may be added to the manifest without breaking a plugin that predates
252
+ them; changing what an existing field means would arrive as version 2, with both
253
+ accepted for a time.
244
254
 
245
255
  Released versions and what landed in each: [CHANGELOG on the Releases page](https://github.com/lacodda/sefy/releases).
246
256
 
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "sefy-cli",
3
- "version": "0.4.0",
3
+ "version": "0.6.0",
4
4
  "sefy": {
5
- "binary": "v0.4.0"
5
+ "binary": "v0.6.0"
6
6
  },
7
7
  "description": "An inconspicuous encrypted store for notes, credentials and files",
8
8
  "license": "MIT",