@sharedenv/cli 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,5 @@
+sharedenv CLI
+Copyright 2026 SharedEnv
+
+This product is part of sharedenv (https://sharedenv.com). Licensed under the
+Apache License, Version 2.0 (see LICENSE).

package/README.md

@@ -1,3 +1,305 @@
-# Temporary Holding Version
+# sharedenv CLI
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**The zero-knowledge secrets vault for teams, in your terminal.**
+
+[![npm](https://img.shields.io/npm/v/@sharedenv/cli)](https://www.npmjs.com/package/@sharedenv/cli)
+[![license](https://img.shields.io/github/license/SharedEnv/cli)](LICENSE)
+
+Your `.env` files have no business in Slack, in an email or in a git repo. With
+[sharedenv](https://sharedenv.com), your team keeps its environment variables, API keys and
+certificates in shared vaults. The CLI brings them to your commands, decrypted on your
+machine: sharedenv itself never sees a single secret.
+
+```bash
+npm install -g @sharedenv/cli
+sharedenv login
+sharedenv run prod -- npm start
+```
+
+## Why teams use it
+
+- **One source of truth for every environment.** One vault per project or environment
+  (dev, staging, prod), shared with exactly the people who need it. No more "can you send me
+  the new key?".
+- **Nothing on disk.** `sharedenv run` starts your app with its secrets in memory. No stale
+  `.env` lying around on laptops, no file to leak.
+- **The same secrets in CI.** Your pipeline fetches what it needs at run time, instead of a
+  copy of every secret in every tool.
+- **Zero-knowledge, for real.** Secrets are encrypted before they leave your device and
+  decrypted only on the devices of the people you share them with. A breach of our servers
+  would expose encrypted values, never a secret.
+
+## Get started in two minutes
+
+1. **Create your account** on [sharedenv.com](https://sharedenv.com) and your first vault.
+   It is free to start, no credit card.
+2. **Install the CLI** (Node.js 20.19 or later):
+   ```bash
+   npm install -g @sharedenv/cli
+   ```
+3. **Sign in** with your email (or username) and your master password, plus your
+   two-factor code if your account has one:
+   ```bash
+   sharedenv login
+   ```
+4. **Use your vaults:**
+   ```bash
+   sharedenv list                      # your vaults
+   sharedenv run prod -- npm start     # your app, with the prod secrets
+   ```
+
+## Everyday use
+
+### Run anything with its secrets
+
+```bash
+sharedenv run prod -- npm start
+sharedenv run staging -- docker compose up
+sharedenv run prod -- python manage.py migrate
+```
+
+The secrets reach the command as environment variables, in memory. The command's exit code
+is passed through, so scripts and CI behave exactly as without sharedenv.
+
+A variable your shell already sets wins over the vault, so a local `DATABASE_URL` is never
+replaced behind your back: add `--override-env` when you want the vault's value.
+
+### Get your secrets as a file, or as JSON
+
+```bash
+sharedenv pull prod                    # dotenv, on stdout
+sharedenv pull prod --out .env         # the same, in a file only you can read
+sharedenv pull prod --format json      # JSON, for scripts and programs
+```
+
+stdout carries the secrets and nothing else (questions and messages go to stderr), so
+pipes and redirections get clean data. From a script or a program there is no terminal to
+ask for your master password: set `SHAREDENV_PASSWORD`.
+
+#### dotenv (the default)
+
+For a vault holding five secrets, `sharedenv pull prod` prints:
+
+```dotenv
+APP_NAME='Acme billing'
+DATABASE_URL=postgres://app:s3cret@db.internal:5432/app
+JWT_PRIVATE_KEY='-----BEGIN PRIVATE KEY-----
+MIIEvQIBADANBgkqhkiG9w0BAQEFAASC
+-----END PRIVATE KEY-----'
+SMTP_PASSWORD="it's a pass"
+STRIPE_KEY=sk_test_example
+```
+
+- One `NAME=value` per secret, sorted by name, so two pulls of the same vault give the
+  same file.
+- A value is written as is when it holds only plain characters, between single quotes
+  otherwise (multi-line values such as a PEM key included), and between double quotes when
+  it contains a single quote.
+- Nothing is ever expanded or executed when the file is read. A value that no quoting can
+  carry safely (a single quote together with `"`, `$`, a backtick or `\`) is refused with
+  its name: use `--format json` for that vault.
+
+Every common reader loads it as is:
+
+```bash
+set -a; . ./.env; set +a                 # a shell (bash, zsh, sh)
+node --env-file=.env server.js           # Node.js 20.12 or later
+```
+
+```js
+import 'dotenv/config'; // Node.js, with the dotenv package
+```
+
+```python
+from dotenv import load_dotenv  # Python, with python-dotenv
+load_dotenv()
+```
+
+One exception: `docker run --env-file` reads values literally (it would keep the quotes)
+and refuses multi-line values. Hand the variables to Docker through `run` instead:
+
+```bash
+sharedenv run prod -- docker run -e DATABASE_URL -e STRIPE_KEY my-app
+```
+
+#### JSON
+
+`sharedenv pull prod --format json` prints one object, names sorted, every value a string:
+
+```json
+{
+  "APP_NAME": "Acme billing",
+  "DATABASE_URL": "postgres://app:s3cret@db.internal:5432/app",
+  "JWT_PRIVATE_KEY": "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASC\n-----END PRIVATE KEY-----",
+  "SMTP_PASSWORD": "it's a pass",
+  "STRIPE_KEY": "sk_test_example"
+}
+```
+
+One value, from a shell:
+
+```bash
+sharedenv pull prod --format json | jq -r .DATABASE_URL
+```
+
+From a program:
+
+```js
+// Node.js
+import { execFileSync } from 'node:child_process';
+
+const secrets = JSON.parse(
+  execFileSync('sharedenv', ['pull', 'prod', '--format', 'json'], { encoding: 'utf8' })
+);
+console.log(secrets.DATABASE_URL);
+```
+
+```python
+# Python
+import json
+import subprocess
+
+secrets = json.loads(
+    subprocess.run(
+        ["sharedenv", "pull", "prod", "--format", "json"],
+        check=True, capture_output=True, text=True,
+    ).stdout
+)
+print(secrets["DATABASE_URL"])
+```
+
+If the command fails (wrong password, unknown vault, no network), it exits with a non-zero
+code and says why on stderr: `execFileSync` throws, and `check=True` raises.
+
+### Accept what your team shares with you
+
+When a teammate shares a vault with you, it waits for your answer:
+
+```bash
+sharedenv list                # the shares waiting for you, with who sent them
+sharedenv accept staging      # shows the sender's key fingerprint, then asks
+sharedenv decline staging
+```
+
+Before you accept, compare the fingerprint with the sender over another channel (a call,
+a chat). It proves the share really comes from them. They can check yours the same way:
+`sharedenv fingerprint`.
+
+### Sign out
+
+```bash
+sharedenv logout              # closes the session on our side too
+```
+
+## In CI/CD
+
+The CLI asks nothing when there is no terminal: give it what it would ask for, from your
+CI's secret store.
+
+**GitHub Actions**
+
+```yaml
+- run: npm install -g @sharedenv/cli
+- run: sharedenv login
+  env:
+    SHAREDENV_IDENTIFIER: ${{ secrets.SHAREDENV_IDENTIFIER }}
+    SHAREDENV_PASSWORD: ${{ secrets.SHAREDENV_PASSWORD }}
+- run: sharedenv run prod -- ./deploy.sh
+  env:
+    SHAREDENV_PASSWORD: ${{ secrets.SHAREDENV_PASSWORD }}
+```
+
+**GitLab CI**
+
+```yaml
+deploy:
+  script:
+    - npm install -g @sharedenv/cli
+    - sharedenv login
+    - sharedenv run prod -- ./deploy.sh
+  # SHAREDENV_IDENTIFIER and SHAREDENV_PASSWORD: masked CI/CD variables
+```
+
+**Docker** (the secrets are fetched when the container starts, never baked into the image)
+
+```dockerfile
+RUN npm install -g @sharedenv/cli
+CMD ["sh", "-c", "sharedenv login && exec sharedenv run prod -- node server.js"]
+```
+
+```bash
+docker run -e SHAREDENV_IDENTIFIER -e SHAREDENV_PASSWORD my-app
+```
+
+Good practice for pipelines:
+
+- **Use a dedicated account** for CI, and share with it only the vaults the job needs,
+  read-only. Its master password opens every vault of that account.
+- **Prefer `run` to `pull`**, and never print a `pull` to the job log.
+- **A second factor needs a code at login** (`SHAREDENV_OTP`), which a pipeline cannot
+  produce on its own: keep the CI account without one, and limited as above.
+
+## How your secrets stay yours
+
+- **Encrypted on your device.** AES-256-GCM for the secrets, sharing through signed ECDH
+  (secp256k1), your password stretched with scrypt. Standard primitives, nothing home-made.
+- **Your password and your private key never leave your machine.** Signing in sends a
+  verifier derived from your password, never the password. Your private key is unlocked in
+  memory for the command, and never written anywhere.
+- **You know who shares with you.** A share opens only if it was sealed by its sender, and
+  the CLI remembers the keys it has seen: if someone's key ever changes, it stops and asks.
+- **A vault cannot take over your machine.** Anyone who can edit a vault chooses its
+  values, so `run` holds back variables that would make a program run code or reroute its
+  traffic (`LD_*`, `PATH`, `NODE_OPTIONS`, proxies, custom certificates...) unless you pass
+  `--allow-unsafe-env`. Your master password is never passed to the command.
+- **Open source.** The CLI and its cryptography (`lib/crypto/`) are here for anyone to
+  read. Found something? See [SECURITY.md](SECURITY.md).
+
+What it does not protect against, said plainly:
+
+- **Names.** Vault names and secret names (like `DATABASE_URL`) are stored in clear, so
+  that they can be listed and organized; values, and the URL and username that go with
+  them, are encrypted. Never put a secret in a name.
+- **The first contact.** The first key the CLI sees for someone is the one our directory
+  serves; comparing fingerprints once settles it for good.
+- **After you accept a share**, its sender is not checked again; and an older value of the
+  same secret could be served back to you.
+- **Your own account on your own machine.** The session file (`~/.sharedenv/session.json`,
+  readable by you only) lets a program running as you act as you: sign out on machines you
+  do not trust.
+
+## Reference
+
+| Command                                                               | What it does                                               |
+| --------------------------------------------------------------------- | ---------------------------------------------------------- |
+| `sharedenv login [--api <url>] [--identifier <id>]`                   | Sign in. Keeps the session, nothing else.                  |
+| `sharedenv list`                                                      | Your vaults, then the shares waiting for your answer.      |
+| `sharedenv run <vault> -- <command>`                                  | Run a command with the vault's secrets in its environment. |
+| `sharedenv pull <vault> [--out <file>] [--format dotenv\|json]`       | Print or write the secrets.                                |
+| `sharedenv accept <vault> [--team <id>] [--yes] [--fingerprint <fp>]` | Accept a share after checking who sealed it.               |
+| `sharedenv decline <vault> [--team <id>]`                             | Decline a share.                                           |
+| `sharedenv fingerprint`                                               | Your key fingerprint, to read to a teammate.               |
+| `sharedenv logout`                                                    | Close the session, on our side and on this machine.        |
+
+`<vault>` is a vault's name or id. `sharedenv help <command>` lists every option.
+
+| Environment variable   | Use                                                     |
+| ---------------------- | ------------------------------------------------------- |
+| `SHAREDENV_IDENTIFIER` | Email or username, for a login without questions.       |
+| `SHAREDENV_PASSWORD`   | Master password, for commands without questions.        |
+| `SHAREDENV_OTP`        | Two-factor code, for a login without questions.         |
+| `SHAREDENV_API`        | API URL (default `https://api.sharedenv.com`).          |
+| `SHAREDENV_HOME`       | Where the CLI keeps its files (default `~/.sharedenv`). |
+
+The CLI keeps two files there, both readable by you only: `session.json` (your session)
+and `pins.json` (the public keys this machine has checked). Never a secret, never your
+password, never your private key.
+
+Exit codes: `0` success, `1` error, `2` wrong usage, `130` cancelled. With `run`: the
+command's own code, `128 + n` when signal `n` ended it, `127` when the command does not
+exist.
+
+## License
+
+Apache License 2.0, see [LICENSE](LICENSE) and [NOTICE](NOTICE). Made by
+[SharedEnv](https://sharedenv.com).