@plentidev/cli-linux-x64 0.0.8

package/README.md

@@ -0,0 +1,228 @@
+# Plenti CLI
+
+CLI for managing internal Plenti utilities.
+
+## Installation
+
+The repository is private, but the CLI binary is published on npm.
+
+Install it globally:
+
+```bash
+npm install -g @plenti/cli
+```
+
+You can also install a specific version:
+
+```bash
+npm install -g @plenti/cli@0.0.1
+```
+
+The npm package only ships the prebuilt binaries and a small launcher that selects the correct binary for the current platform.
+
+### Manual binary installation
+
+If you prefer, you can still manually download the correct binary from the corresponding GitHub Release.
+
+### macOS / Linux / WSL
+
+Download the correct file for your platform:
+
+- `plenti-<version>-darwin-arm64.tar.gz`
+- `plenti-<version>-darwin-x64.tar.gz`
+- `plenti-<version>-linux-arm64.tar.gz`
+- `plenti-<version>-linux-x64.tar.gz`
+- `plenti-<version>-linux-arm64-musl.tar.gz`
+- `plenti-<version>-linux-x64-musl.tar.gz`
+
+Then install the binary:
+
+```bash
+tar -xzf plenti-0.0.1-linux-x64.tar.gz
+chmod +x plenti-linux-x64
+mkdir -p ~/.local/bin
+mv plenti-linux-x64 ~/.local/bin/plenti
+```
+
+If `~/.local/bin` is not in your `PATH`, add this to `~/.zshrc` or `~/.bashrc`:
+
+```bash
+export PATH="$HOME/.local/bin:$PATH"
+```
+
+Verify the installation:
+
+```bash
+plenti --help
+```
+
+Update the installed binary:
+
+```bash
+plenti self-update
+```
+
+## Requirements
+
+You only need [Bun](https://bun.sh) to develop and build the project. End users of the distributed binary do not need Bun.
+
+For `plenti self-update`, the machine must also have GitHub access to the private repository. The command supports:
+
+- `GITHUB_TOKEN`
+- `GH_TOKEN`
+- authenticated GitHub CLI via `gh auth login`
+
+**IMPORTANT**: Installing AWS CLI is required to use the package, including the distributed binary.
+
+```bash
+# Ubuntu/Debian/WSL
+curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
+unzip awscliv2.zip
+sudo ./aws/install
+
+# macOS
+brew install awscli
+
+# Verify installation
+aws --version  # Should show AWS CLI 2.x
+```
+
+## Configure AWS SSO
+
+After installing AWS CLI, configure SSO access. This is also required when a command needs to authenticate against AWS:
+
+```bash
+aws configure sso --profile dev
+aws configure sso --profile prod
+```
+
+Base configuration required for both profiles:
+
+```txt
+SSO session name (Recommended): plenti
+SSO start URL: https://somosplenti.awsapps.com/start/
+SSO region: us-east-1
+SSO registration scopes: sso:account:access
+CLI default client Region: us-east-1
+CLI default output format: json
+```
+
+Choose the `dev` account in the first command and the `prod` account in the second.
+
+The CLI resolves the AWS profile in this order:
+
+1. `--profile dev|prod`
+2. `PLENTI_AWS_PROFILE`
+3. `AWS_PROFILE`
+
+If `AWS_REGION` or `AWS_DEFAULT_REGION` is not defined, the CLI uses `sa-east-1` by default.
+
+## Development
+
+Install dependencies:
+
+```bash
+bun install
+```
+
+Build the binaries:
+
+```bash
+bun run build
+```
+
+Package release-ready assets:
+
+```bash
+bun run build:release
+```
+
+## Publishing
+
+The repository includes a GitHub Actions workflow at `.github/workflows/release.yml` that publishes the npm package automatically when you push a `v*` tag.
+
+Flow:
+
+```bash
+bun run typecheck
+git tag v0.0.1
+git push origin v0.0.1
+```
+
+The workflow validates that the tag matches `package.json`, builds the binaries, and publishes `@plenti/cli` to npm.
+
+## Usage
+
+Once the binary is installed, use it directly with `plenti`.
+
+To pull variables, the repository where you run the command must contain an `env.ssm.ts` file at the project root.
+
+That file must export an `SSM_MAPPING` object where:
+
+- the key is the environment variable name that will be written to `.env`
+- the value is the AWS SSM parameter name or path
+
+Example:
+
+```ts
+export const SSM_MAPPING = {
+  DATABASE_URL: '/project/support-portal/DATABASE_URL',
+  BACKEND_API_URL: '/project/support-portal/BACKEND_API_URL',
+  BACKEND_API_KEY: '/project/support-portal/BACKEND_API_KEY',
+  SESSION_SECRET: '/project/support-portal/SESSION_SECRET',
+};
+```
+
+When you run `plenti env pull`, the CLI:
+
+1. reads `env.ssm.ts`
+2. downloads those parameters from AWS SSM
+3. generates a `.env` file at the project root
+
+Example generated `.env`:
+
+```dotenv
+DATABASE_URL=postgres://...
+BACKEND_API_URL=https://api.example.com
+BACKEND_API_KEY=...
+SESSION_SECRET=...
+```
+
+Show help:
+
+```bash
+plenti --help
+```
+
+Update the installed binary to the latest version:
+
+```bash
+plenti self-update
+```
+
+Update to a specific version:
+
+```bash
+plenti self-update --version 0.0.1
+```
+
+Download environment variables from AWS SSM using `env.ssm.ts`:
+
+```bash
+plenti env pull --profile dev
+```
+
+You can also use `prod`:
+
+```bash
+plenti env pull --profile prod
+```
+
+## Local Usage
+
+If you have not installed the binary yet and you are testing locally from the project, you can run the CLI directly with Bun:
+
+```bash
+bun bin/index.ts --help
+bun bin/index.ts env pull --profile dev
+```

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@plentidev/cli-linux-x64",
+  "version": "0.0.8",
+  "description": "Official Plenti CLI (plenti-linux-x64)",
+  "os": [
+    "linux"
+  ],
+  "cpu": [
+    "x64"
+  ],
+  "libc": [
+    "glibc"
+  ],
+  "files": [
+    "bin"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}