slickenv 0.0.1 → 0.0.2

package/README.md

@@ -0,0 +1,210 @@
+# SlickEnv
+
+CLI tool for securely managing, syncing, and versioning `.env` files across your team.
+
+- **End-to-end encrypted** — Private variables are encrypted client-side with AES-256-GCM before leaving your machine
+- **Version history** — Every push creates an immutable version you can diff, rollback, or audit
+- **Team sync** — Pull the latest environment from anywhere, always in sync
+- **Zero plaintext on server** — The server never sees your unencrypted secrets
+
+## Install
+
+```bash
+npm install -g slickenv
+```
+
+## Quick Start
+
+```bash
+# Authenticate via browser
+slickenv login
+
+# Initialize a project in your repo
+slickenv init --name my-app
+
+# Push your .env to SlickEnv
+slickenv push -m "Initial environment"
+
+# Pull from another machine or teammate
+slickenv pull
+```
+
+## Commands
+
+### Authentication
+
+#### `slickenv login`
+
+Open browser to authenticate via OAuth. Your token is stored securely in the OS keychain (with a file fallback).
+
+#### `slickenv logout`
+
+Revoke your token and clear local credentials.
+
+### Project Setup
+
+#### `slickenv init`
+
+Initialize a SlickEnv project in the current directory. Creates a `.slickenv` config file and ensures `.env` is in your `.gitignore`.
+
+```bash
+slickenv init --name my-app --env production
+```
+
+| Flag    | Description                          | Default              |
+| ------- | ------------------------------------ | -------------------- |
+| `--name`| Project name                         | Current directory    |
+| `--env` | Default environment label            | `production`         |
+
+### Syncing
+
+#### `slickenv push`
+
+Push local `.env` changes to SlickEnv. Private variables are encrypted before upload.
+
+```bash
+slickenv push -m "Add Stripe keys" --yes
+```
+
+| Flag            | Description                          | Default  |
+| --------------- | ------------------------------------ | -------- |
+| `--file`        | Path to env file                     | `.env`   |
+| `--force`       | Skip conflict check                  | `false`  |
+| `--message, -m` | Version description                  | —        |
+| `--yes, -y`     | Auto-confirm prompts                 | `false`  |
+
+#### `slickenv pull`
+
+Pull the latest (or a specific) version and write it to your local `.env`.
+
+```bash
+slickenv pull --version 3 --dry-run
+```
+
+| Flag        | Description                        | Default  |
+| ----------- | ---------------------------------- | -------- |
+| `--version` | Pull a specific version            | latest   |
+| `--dry-run` | Preview without writing to disk    | `false`  |
+| `--yes, -y` | Auto-confirm overwrite             | `false`  |
+
+### Version History
+
+#### `slickenv versions`
+
+List version history for the current environment.
+
+```bash
+slickenv versions --limit 10
+```
+
+| Flag      | Description               | Default |
+| --------- | ------------------------- | ------- |
+| `--limit` | Number of versions        | `20`    |
+
+#### `slickenv diff <version-a> <version-b>`
+
+Show what changed between two versions.
+
+```bash
+slickenv diff 3 5
+```
+
+#### `slickenv rollback <version>`
+
+Roll back to a previous version. This is non-destructive — it creates a new version with the contents of the target version.
+
+```bash
+slickenv rollback 2 --yes
+```
+
+| Flag        | Description            | Default |
+| ----------- | ---------------------- | ------- |
+| `--yes, -y` | Auto-confirm rollback  | `false` |
+
+### Sharing
+
+#### `slickenv export`
+
+Generate a `.env.example` file with metadata annotations. Public variables include their values; private variables show only examples or placeholders.
+
+```bash
+slickenv export --out .env.example
+```
+
+| Flag    | Description        | Default         |
+| ------- | ------------------ | --------------- |
+| `--out` | Output file path   | `.env.example`  |
+
+#### `slickenv share`
+
+Display a shareable view of the current environment. Private values are masked by default.
+
+```bash
+slickenv share --public-only
+slickenv share --reveal
+```
+
+| Flag            | Description                     | Default |
+| --------------- | ------------------------------- | ------- |
+| `--public-only` | Show only public variables      | `false` |
+| `--reveal`      | Show private values in plain    | `false` |
+
+#### `slickenv status`
+
+Show what's different between your local `.env` and the remote version.
+
+### Global Flags
+
+All commands support:
+
+| Flag         | Description              |
+| ------------ | ------------------------ |
+| `--json`     | Output as JSON           |
+| `--no-color` | Disable colored output   |
+| `--verbose`  | Show debug information   |
+
+## `.env` Metadata Annotations
+
+SlickEnv supports metadata annotations as comments above your variables:
+
+```bash
+# @visibility=public @type=string @required=true
+APP_NAME=my-app
+
+# @visibility=private @required=true @example=sk_live_xxx
+STRIPE_SECRET_KEY=sk_live_abc123
+```
+
+| Annotation      | Values                         | Default     |
+| --------------- | ------------------------------ | ----------- |
+| `@visibility`   | `public`, `private`            | `private`   |
+| `@type`         | `string`, `number`, `boolean`  | `string`    |
+| `@required`     | `true`, `false`                | `false`     |
+| `@example`      | Any value                      | —           |
+
+Variables marked `private` are encrypted client-side before syncing. Variables marked `public` are stored in plaintext.
+
+## Security
+
+SlickEnv uses **client-side AES-256-GCM encryption** so private variables never leave your machine unencrypted.
+
+- **Key derivation**: PBKDF2-SHA256 (100,000 iterations) using your user identity, project ID, and a server-side salt
+- **Encryption**: AES-256-GCM with a unique 12-byte IV per variable and 128-bit authentication tags
+- **Token storage**: OS keychain via keytar, with a chmod 600 file fallback
+- **Zero knowledge**: The server stores only ciphertext — it cannot read your private variables
+
+## Environment Variables
+
+| Variable            | Description                          | Default                               |
+| ------------------- | ------------------------------------ | ------------------------------------- |
+| `SLICKENV_API_URL`  | Override the backend API URL         | `https://apienv.slickspender.com`     |
+| `SLICKENV_AUTH_URL` | Override the auth website URL        | `https://env.slickspender.com`        |
+| `SLICKENV_TOKEN`    | Use a token directly (CI/CD)        | —                                     |
+
+## Documentation
+
+Full documentation is available at [env.slickspender.com/docs](https://env.slickspender.com/docs).
+
+## License
+
+MIT

package/oclif.manifest.json

@@ -590,5 +590,5 @@
       ]
     }
   },
-  "version": "0.0.1"
+  "version": "0.0.2"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "slickenv",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "CLI tool for securely managing, syncing, and versioning .env files",
   "type": "module",
   "license": "MIT",