@envpilot/cli 1.4.1 → 1.5.0

package/LICENSE

@@ -0,0 +1,8 @@
+Copyright (c) 2024-present Envpilot. All rights reserved.
+
+This software is proprietary and confidential. No part of this software may be
+reproduced, distributed, or transmitted in any form or by any means without the
+prior written permission of Envpilot.
+
+For licensing inquiries, contact hello@envpilot.dev.
+See https://www.envpilot.dev/terms for the full Terms of Service.

package/README.md

@@ -1,8 +1,8 @@
 # @envpilot/cli
 
-The official CLI for [Envpilot](https://www.envpilot.dev) — a secure environment variable management platform for teams.
+The official CLI for [Envpilot](https://www.envpilot.dev) -- a secure environment variable management platform for teams.
 
-Envpilot lets you sync, share, and manage `.env` files across your team without leaking secrets in Slack, email, or Git. Variables are encrypted at rest using [WorkOS Vault](https://workos.com/vault) and access is controlled through role-based permissions.
+Sync, share, and manage `.env` files across your team without leaking secrets in Slack, email, or Git. Variables are encrypted at rest using [WorkOS Vault](https://workos.com/vault) and access is enforced through role-based permissions.
 
 ## Install
 
@@ -10,7 +10,7 @@ Envpilot lets you sync, share, and manage `.env` files across your team without
 npm install -g @envpilot/cli
 ```
 
-Or with bun:
+With bun:
 
 ```bash
 bun install -g @envpilot/cli
@@ -25,46 +25,123 @@ npx @envpilot/cli login
 ## Quick Start
 
 ```bash
-# Authenticate with your Envpilot account
-envpilot login
+# One-command setup: authenticate, select a project, and pull variables
+envpilot sync
 
-# Initialize a project in the current directory
-envpilot init
+# Or step by step:
+envpilot login                   # Authenticate with your Envpilot account
+envpilot init                    # Link the current directory to a project
+envpilot pull                    # Pull variables into a local .env file
+```
+
+## Interactive Terminal UI
 
-# Pull environment variables into a .env file
-envpilot pull
+Run `envpilot` with no arguments to open the interactive TUI. Browse commands, read documentation, and launch any command directly from the keyboard-driven dashboard.
 
-# Push local .env changes to Envpilot
-envpilot push
+```bash
+envpilot
 ```
 
+The TUI returns after each command finishes, so you can run multiple commands in one session. Press **Esc** to exit.
+
 ## Commands
 
-| Command                   | Description                                         |
-| ------------------------- | --------------------------------------------------- |
-| `envpilot login`          | Authenticate with your Envpilot account             |
-| `envpilot logout`         | Log out and clear stored credentials                |
-| `envpilot init`           | Link the current directory to an Envpilot project   |
-| `envpilot pull`           | Pull environment variables into a local `.env` file |
-| `envpilot push`           | Push local `.env` changes to Envpilot               |
-| `envpilot list orgs`      | List your organizations                             |
-| `envpilot list projects`  | List projects in the active organization            |
-| `envpilot list variables` | List variables in the active project                |
-| `envpilot switch`         | Switch the active project                           |
-| `envpilot config`         | View or update CLI configuration                    |
-| `envpilot whoami`         | Show the currently authenticated user               |
+### Getting Started
+
+| Command                    | Description                                             |
+| -------------------------- | ------------------------------------------------------- |
+| `envpilot`                 | Open the interactive terminal UI                        |
+| `envpilot ui`              | Open the interactive terminal UI (explicit)             |
+| `envpilot login [options]` | Authenticate with your Envpilot account                 |
+| `envpilot sync [options]`  | Authenticate, select a project, and pull in one flow    |
+| `envpilot init [options]`  | Link the current directory to a project and environment |
+| `envpilot man [command]`   | Show the CLI manual page                                |
+
+### Syncing Variables
+
+| Command                   | Description                             |
+| ------------------------- | --------------------------------------- |
+| `envpilot pull [options]` | Pull variables into a local `.env` file |
+| `envpilot push [options]` | Push local `.env` changes to Envpilot   |
+
+### Browsing Resources
+
+| Command                       | Description                                        |
+| ----------------------------- | -------------------------------------------------- |
+| `envpilot list`               | List projects in the active organization (default) |
+| `envpilot list organizations` | List your organizations                            |
+| `envpilot list projects`      | List projects in the active organization           |
+| `envpilot list variables`     | List variables in the active project               |
+| `envpilot list linked`        | List projects linked in the current directory      |
+| `envpilot usage [options]`    | Show plan usage and feature limits                 |
+
+### Project Management
+
+| Command                     | Description                                             |
+| --------------------------- | ------------------------------------------------------- |
+| `envpilot switch [options]` | Switch the active organization, project, or environment |
+| `envpilot unlink [project]` | Remove a linked project from the current directory      |
+
+### Account
+
+| Command                        | Description                                     |
+| ------------------------------ | ----------------------------------------------- |
+| `envpilot whoami`              | Show the authenticated user and active context  |
+| `envpilot config [subcommand]` | View or update CLI configuration                |
+| `envpilot logout`              | Revoke the session and clear stored credentials |
+
+Run `envpilot man` for the full command reference, or `envpilot man <command>` for detailed help on a specific command.
+
+## Common Options
+
+| Flag                    | Applies to                                     | Description                                                          |
+| ----------------------- | ---------------------------------------------- | -------------------------------------------------------------------- |
+| `--api-url <url>`       | `login`                                        | Override the API URL                                                 |
+| `--no-browser`          | `login`                                        | Skip automatic browser open                                          |
+| `--organization <id>`   | `sync`, `init`, `switch`                       | Target a specific organization                                       |
+| `--project <id>`        | `sync`, `init`, `switch`                       | Target a specific project                                            |
+| `--env <environment>`   | `sync`, `init`, `pull`, `push`, `switch`       | Target an environment (development, staging, production)             |
+| `--file <path>`         | `pull`, `push`                                 | Custom file path (default: `.env`)                                   |
+| `--format <format>`     | `pull`                                         | Output format: env, json, yaml, vercel, netlify, aws, docker-compose |
+| `--merge` / `--replace` | `push`                                         | Merge with or replace remote variables                               |
+| `--dry-run`             | `pull`                                         | Preview changes without writing to disk                              |
+| `--json`                | `list projects`, `list organizations`, `usage` | Output as JSON                                                       |
+| `--force`               | `unlink`                                       | Skip confirmation prompt                                             |
+
+## Pull Formats
+
+`envpilot pull` supports multiple export formats for integration with different platforms:
+
+```bash
+envpilot pull                              # .env (default)
+envpilot pull --format json                # JSON
+envpilot pull --format yaml                # YAML
+envpilot pull --format vercel              # Vercel
+envpilot pull --format netlify             # Netlify
+envpilot pull --format aws                 # AWS Parameter Store
+envpilot pull --format docker-compose      # Docker Compose
+```
 
 ## Role-Based Access
 
 Envpilot enforces two-tier role-based access control:
 
-**Organization roles**: Admin, Team Lead, Member
+**Organization roles** -- Admin, Team Lead, Member
+
+**Project roles** -- Manager, Developer, Viewer
+
+| Role      | Pull                     | Push (direct) | Push (approval request) | Manage permissions |
+| --------- | ------------------------ | ------------- | ----------------------- | ------------------ |
+| Manager   | Yes                      | Yes           | --                      | Yes                |
+| Developer | Yes                      | No            | Yes                     | No                 |
+| Viewer    | Permitted variables only | No            | No                      | No                 |
 
-**Project roles**: Manager, Developer, Viewer
+## Security
 
-- **Viewers** have read-only access to explicitly permitted variables
-- **Developers** can push changes, which creates pending approval requests
-- **Managers** can push directly and approve pending requests
+- Variables are encrypted at rest using [WorkOS Vault](https://workos.com/vault).
+- The CLI never stores plaintext secret values on disk.
+- Authentication uses a device-code flow with short-lived access tokens and refresh tokens.
+- All API communication is over HTTPS.
 
 ## Requirements
 
@@ -74,10 +151,10 @@ Envpilot enforces two-tier role-based access control:
 ## Links
 
 - [Website](https://www.envpilot.dev)
+- [Documentation](https://www.envpilot.dev/docs)
 - [Privacy Policy](https://www.envpilot.dev/privacy)
-- [Terms & Conditions](https://www.envpilot.dev/terms)
-- [GitHub](https://github.com/rafay99-epic/envpilot.dev)
+- [Terms of Service](https://www.envpilot.dev/terms)
 
 ## License
 
-This software is proprietary. See [Terms & Conditions](https://www.envpilot.dev/terms) for details.
+Proprietary. See [Terms of Service](https://www.envpilot.dev/terms) for details.

package/dist/app-KHDRTCOB.js

@@ -0,0 +1,216 @@
+import {
+  formatArgv,
+  getApiUrl,
+  getTopLevelCommandCatalog,
+  getUser,
+  isAuthenticated
+} from "./chunk-CIIQSYAS.js";
+
+// src/ui/app.tsx
+import {
+  startTransition,
+  useDeferredValue,
+  useEffect,
+  useMemo,
+  useState
+} from "react";
+import { Box, Text, useApp, useInput } from "ink";
+import { jsx, jsxs } from "react/jsx-runtime";
+var searchIndex = /* @__PURE__ */ new WeakMap();
+function getSearchableText(command) {
+  let text = searchIndex.get(command);
+  if (text === void 0) {
+    const parts = [
+      command.title,
+      command.description,
+      formatArgv(command.argv),
+      command.args ?? "",
+      command.category
+    ];
+    if (command.aliases) {
+      for (const alias of command.aliases) parts.push(formatArgv(alias));
+    }
+    for (const example of command.examples) parts.push(formatArgv(example));
+    for (const note of command.notes) parts.push(note);
+    for (const kw of command.keywords) parts.push(kw);
+    text = parts.filter(Boolean).join(" ").toLowerCase();
+    searchIndex.set(command, text);
+  }
+  return text;
+}
+function matchesQuery(command, query) {
+  if (!query.trim()) {
+    return true;
+  }
+  return getSearchableText(command).includes(query.trim().toLowerCase());
+}
+var TOP_LEVEL_CATALOG = getTopLevelCommandCatalog();
+function useCommandSearch() {
+  const [query, setQuery] = useState("");
+  const deferredQuery = useDeferredValue(query);
+  const commands = useMemo(
+    () => TOP_LEVEL_CATALOG.filter(
+      (command) => matchesQuery(command, deferredQuery)
+    ),
+    [deferredQuery]
+  );
+  return {
+    query,
+    commands,
+    updateQuery(nextValue) {
+      startTransition(() => {
+        setQuery(nextValue);
+      });
+    }
+  };
+}
+function Section({
+  title,
+  children
+}) {
+  return /* @__PURE__ */ jsxs(Box, { flexDirection: "column", marginBottom: 1, children: [
+    /* @__PURE__ */ jsx(Text, { color: "greenBright", children: title }),
+    children
+  ] });
+}
+function CLIApp({ onSelectCommand }) {
+  const { exit } = useApp();
+  const { query, commands, updateQuery } = useCommandSearch();
+  const [selectedIndex, setSelectedIndex] = useState(0);
+  const [isRunning, setIsRunning] = useState(false);
+  useEffect(() => {
+    if (selectedIndex >= commands.length) {
+      setSelectedIndex(Math.max(commands.length - 1, 0));
+    }
+  }, [commands.length, selectedIndex]);
+  const selectedCommand = commands[selectedIndex] ?? TOP_LEVEL_CATALOG[0];
+  const user = getUser();
+  useInput((input, key) => {
+    if (isRunning) {
+      return;
+    }
+    if (key.escape) {
+      exit();
+      return;
+    }
+    if (key.return && selectedCommand) {
+      setIsRunning(true);
+      onSelectCommand?.(selectedCommand.argv);
+      exit();
+      return;
+    }
+    if (key.upArrow) {
+      setSelectedIndex(
+        (current) => current === 0 ? commands.length - 1 : current - 1
+      );
+      return;
+    }
+    if (key.downArrow) {
+      setSelectedIndex(
+        (current) => current >= commands.length - 1 ? 0 : current + 1
+      );
+      return;
+    }
+    if (key.backspace || key.delete) {
+      updateQuery(query.slice(0, -1));
+      return;
+    }
+    if (key.ctrl && input === "u") {
+      updateQuery("");
+      return;
+    }
+    if (!key.ctrl && !key.meta && input) {
+      updateQuery(query + input);
+    }
+  });
+  return /* @__PURE__ */ jsxs(Box, { flexDirection: "column", padding: 1, children: [
+    /* @__PURE__ */ jsxs(
+      Box,
+      {
+        borderStyle: "round",
+        borderColor: "green",
+        paddingX: 1,
+        paddingY: 1,
+        flexDirection: "column",
+        children: [
+          /* @__PURE__ */ jsx(Text, { color: "greenBright", children: "Envpilot CLI" }),
+          /* @__PURE__ */ jsx(Text, { color: "gray", children: "Website-aligned terminal UI for auth, projects, variables, and usage." }),
+          /* @__PURE__ */ jsxs(Box, { marginTop: 1, flexDirection: "column", children: [
+            /* @__PURE__ */ jsxs(Text, { children: [
+              /* @__PURE__ */ jsx(Text, { color: "gray", children: "API " }),
+              /* @__PURE__ */ jsx(Text, { color: "cyan", children: getApiUrl() })
+            ] }),
+            /* @__PURE__ */ jsxs(Text, { children: [
+              /* @__PURE__ */ jsx(Text, { color: "gray", children: "Auth " }),
+              /* @__PURE__ */ jsx(Text, { color: isAuthenticated() ? "green" : "yellow", children: isAuthenticated() ? `Signed in${user?.email ? ` as ${user.email}` : ""}` : "Not signed in" })
+            ] })
+          ] })
+        ]
+      }
+    ),
+    /* @__PURE__ */ jsxs(Box, { marginTop: 1, children: [
+      /* @__PURE__ */ jsx(Text, { color: "gray", children: "Search " }),
+      /* @__PURE__ */ jsx(Text, { color: "white", children: query || "type to filter commands" })
+    ] }),
+    /* @__PURE__ */ jsxs(Box, { marginTop: 1, children: [
+      /* @__PURE__ */ jsxs(
+        Box,
+        {
+          width: "45%",
+          borderStyle: "round",
+          borderColor: "gray",
+          flexDirection: "column",
+          paddingX: 1,
+          paddingY: 1,
+          marginRight: 1,
+          children: [
+            /* @__PURE__ */ jsx(Text, { color: "greenBright", children: "Commands" }),
+            /* @__PURE__ */ jsx(Text, { color: "gray", children: "\u2191/\u2193 move, Enter run, Esc exit, Ctrl+U clear" }),
+            /* @__PURE__ */ jsx(Box, { flexDirection: "column", marginTop: 1, children: commands.length === 0 ? /* @__PURE__ */ jsx(Text, { color: "yellow", children: "No commands match the current search." }) : commands.map((command, index) => {
+              const active = index === selectedIndex;
+              return /* @__PURE__ */ jsxs(Box, { children: [
+                /* @__PURE__ */ jsx(Text, { color: active ? "black" : "gray", children: active ? "\u203A " : "  " }),
+                /* @__PURE__ */ jsx(
+                  Text,
+                  {
+                    backgroundColor: active ? "green" : void 0,
+                    color: active ? "black" : "white",
+                    children: formatArgv(command.argv)
+                  }
+                )
+              ] }, command.id);
+            }) })
+          ]
+        }
+      ),
+      /* @__PURE__ */ jsxs(
+        Box,
+        {
+          width: "55%",
+          borderStyle: "round",
+          borderColor: "gray",
+          flexDirection: "column",
+          paddingX: 1,
+          paddingY: 1,
+          children: [
+            /* @__PURE__ */ jsx(Text, { color: "greenBright", children: selectedCommand.title }),
+            /* @__PURE__ */ jsx(Text, { color: "gray", children: selectedCommand.category }),
+            /* @__PURE__ */ jsxs(Box, { marginTop: 1, flexDirection: "column", children: [
+              /* @__PURE__ */ jsx(Text, { children: selectedCommand.description }),
+              selectedCommand.args ? /* @__PURE__ */ jsx(Text, { color: "gray", children: selectedCommand.args }) : null
+            ] }),
+            /* @__PURE__ */ jsx(Section, { title: "Website alignment", children: /* @__PURE__ */ jsx(Text, { children: selectedCommand.websiteSurface }) }),
+            /* @__PURE__ */ jsx(Section, { title: "Examples", children: selectedCommand.examples.map((example) => /* @__PURE__ */ jsx(Text, { color: "cyan", children: formatArgv(example) }, formatArgv(example))) }),
+            /* @__PURE__ */ jsx(Section, { title: "Notes", children: selectedCommand.notes.map((note) => /* @__PURE__ */ jsxs(Text, { color: "gray", children: [
+              "\u2022 ",
+              note
+            ] }, note)) })
+          ]
+        }
+      )
+    ] })
+  ] });
+}
+export {
+  CLIApp
+};