Skip to content

Version Update to 0.3.0 for Manup Server API Changes #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Amanbig merged 2 commits into from
Sep 5, 2026
Merged

Version Update to 0.3.0 for Manup Server API Changes #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
27332f2
chore: API update related to manup version 0.4.0
Amanbig Sep 5, 2026
193f2af
docs: update CLI documentation site to v0.3.0 with api keys and name-…
Amanbig Sep 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 46 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,24 +75,35 @@ Link your local project directory to a specific project and environment in ManUp

```bash
cd /path/to/my-project

# Interactive wizard:
manup init

# Or scriptable non-interactive linking by project & environment name:
manup init -p my-project -e dev
```

This interactively prompts you to select a project and environment, creating a local `.manup.json` configuration file in your directory.
This creates a local `.manup.json` configuration file in your directory that automatically scopes subsequent CLI commands.

---

## 🔐 Managing Secrets

All secret commands support environment and project resolution by name (e.g. `dev`, `prod`, `staging`), common abbreviations (`dev`, `prod`, `stage`), or ID:

### List Secrets

```bash
# List masked secrets
# List secrets for linked environment (masked values)
manup secrets

# Reveal plain values
# Reveal plaintext values
manup secrets ls --reveal

# Specify environment and project by name
manup secrets ls -e dev
manup secrets ls -p backend-api -e prod

# Output JSON
manup secrets --json
```
Expand All @@ -101,58 +112,74 @@ manup secrets --json

```bash
manup secrets get DATABASE_URL
manup secrets get DATABASE_URL -e prod
```

### Create or Update a Secret

```bash
# Using argument pair
manup secrets set API_TOKEN super_secret_val
manup secrets set API_TOKEN super_secret_val -e dev

# Using KEY=VALUE syntax
manup secrets set API_TOKEN=super_secret_val
manup secrets set API_TOKEN=super_secret_val -e prod -p backend-api
```

### Delete a Secret

```bash
manup secrets delete API_TOKEN
manup secrets delete API_TOKEN -e dev
```

### Export Secrets

```bash
# Export to .env file
manup secrets export --out .env
manup secrets export -e prod --out .env

# Export as shell export commands
manup secrets export --format export
manup secrets export -e dev --format export

# Output JSON map
manup secrets export --format json
# Output JSON key-value map
manup secrets export -e staging --format json
```

---

## 🚀 Running Commands with Vault Secrets (`manup run`)

Inject all environment secrets from your linked ManUp vault into any command without writing them to disk:
Inject all environment secrets from your ManUp vault directly into any process environment without writing secrets to disk:

```bash
# Node.js app
manup run -- node index.js

# NPM script
# Runs with linked environment secrets
manup run -- npm start

# Python / Docker / Custom scripts
manup run -- node index.js
manup run -- python app.py

# Switch environment or project on the fly by name:
manup run -e dev -- npm start
manup run -e prod -- npm test
manup run -p backend -e staging -- npm run build
```

Override environment on the fly:
---

## 🔑 Managing API Keys (`manup keys`)

Provision and manage access tokens (including project-scoped API keys) directly from the CLI:

```bash
manup run --env <environmentId> -- npm test
# List all API keys
manup keys

# Create an organization-wide key (read/write)
manup keys create ci-runner

# Create a read-only key scoped to a specific project with 90-day expiration
manup keys create prod-deployer --scope read-only --project backend --days 90

# Revoke an API key
manup keys delete <keyId>
```

---
Expand Down
73 changes: 57 additions & 16 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -594,6 +594,7 @@
<li><a href="#auth">manup login</a></li>
<li><a href="#whoami">manup whoami</a></li>
<li><a href="#init">manup init</a></li>
<li><a href="#keys">manup keys</a></li>
<li><a href="#secrets">manup secrets</a></li>
<li><a href="#export">manup secrets export</a></li>
<li><a href="#run">manup run</a></li>
Expand Down Expand Up @@ -632,6 +633,7 @@
<li><a href="#auth">manup login</a></li>
<li><a href="#whoami">manup whoami</a></li>
<li><a href="#init">manup init</a></li>
<li><a href="#keys">manup keys</a></li>
<li><a href="#secrets">manup secrets</a></li>
<li><a href="#export">manup secrets export</a></li>
<li><a href="#run">manup run</a></li>
Expand All @@ -651,7 +653,7 @@

<!-- Hero Header -->
<header class="hero">
<span class="hero-badge">v0.2.0 • Open Source</span>
<span class="hero-badge">v0.3.0 • Open Source</span>
<h1 class="hero-title">ManUp CLI</h1>
<p class="hero-subtitle">
Manage, synchronize, and inject environment secrets seamlessly across your projects and automation pipelines.
Expand Down Expand Up @@ -731,7 +733,7 @@ <h3>🔒 Machine-Bound AES Encryption</h3>
<!-- Status Section -->
<section id="whoami">
<h2>👤 Status Check (<code>manup whoami</code>)</h2>
<p>Displays active server URL, logged-in user email, organization ID, and linked directory details.</p>
<p>Displays active server URL, logged-in user email, organization ID, API key scope, project isolation status, and linked directory details.</p>
<div class="code-block">
<div class="code-header">terminal</div>
<pre><code>manup whoami</code></pre>
Expand All @@ -744,56 +746,90 @@ <h2>🔗 Workspace Linking (<code>manup init</code>)</h2>
<p>Links your current directory to a specific project and environment in your ManUp vault by creating a local <code>.manup.json</code> file.</p>
<div class="code-block">
<div class="code-header">terminal</div>
<pre><code>manup init</code></pre>
<pre><code><span class="cmd-comment"># Interactive wizard</span>
manup init

<span class="cmd-comment"># Non-interactive scriptable linking by name</span>
manup init -p backend -e dev</code></pre>
</div>
</section>

<!-- API Keys Section -->
<section id="keys">
<h2>🔑 API Key Management (<code>manup keys</code>)</h2>
<p>Provision, inspect, and revoke API keys with support for project scoping and role-based access.</p>

<div class="code-block">
<div class="code-header">terminal</div>
<pre><code><span class="cmd-comment"># List all active API keys</span>
manup keys

<span class="cmd-comment"># Create an organization-wide key (read/write)</span>
manup keys create ci-runner

<span class="cmd-comment"># Create a project-scoped read-only key with 90-day expiration</span>
manup keys create prod-worker --scope read-only --project backend --days 90

<span class="cmd-comment"># Revoke an API key</span>
manup keys delete &lt;keyId&gt;</code></pre>
</div>
</section>

<!-- Secrets Management Section -->
<section id="secrets">
<h2>🔐 Secret Operations (<code>manup secrets</code>)</h2>
<p>Full CRUD operations for managing decrypted environment variables in your vault.</p>
<p>Full CRUD operations for managing decrypted environment variables in your vault. Supports environment and project targeting by name (e.g. <code>dev</code>, <code>prod</code>), common abbreviations, or ID.</p>

<h3>List Secrets</h3>
<div class="code-block">
<div class="code-header">terminal</div>
<pre><code><span class="cmd-comment"># List masked secrets</span>
<pre><code><span class="cmd-comment"># List masked secrets for linked environment</span>
manup secrets

<span class="cmd-comment"># Reveal plain secret values</span>
manup secrets ls --reveal</code></pre>
<span class="cmd-comment"># Reveal plain values</span>
manup secrets ls --reveal

<span class="cmd-comment"># Target environment and project by name</span>
manup secrets ls -e dev
manup secrets ls -p backend -e prod</code></pre>
</div>

<h3>Set Secret</h3>
<div class="code-block">
<div class="code-header">terminal</div>
<pre><code>manup secrets set DATABASE_URL postgres://user:pass@localhost:5432/db</code></pre>
<pre><code><span class="cmd-comment"># Argument pair or KEY=VALUE syntax</span>
manup secrets set DATABASE_URL postgres://user:pass@localhost:5432/db -e dev
manup secrets set PORT=3000 -e prod -p backend</code></pre>
</div>

<h3>Get Secret</h3>
<div class="code-block">
<div class="code-header">terminal</div>
<pre><code>manup secrets get DATABASE_URL</code></pre>
<pre><code>manup secrets get DATABASE_URL -e prod</code></pre>
</div>

<h3>Delete Secret</h3>
<div class="code-block">
<div class="code-header">terminal</div>
<pre><code>manup secrets delete DATABASE_URL</code></pre>
<pre><code>manup secrets delete OLD_TOKEN -e dev</code></pre>
</div>
</section>

<!-- Export Section -->
<section id="export">
<h2>📄 Exporting Secrets</h2>
<p>Export environment variables to <code>.env</code> files or standard export scripts.</p>
<p>Export environment variables to <code>.env</code> files, standard shell export scripts, or JSON maps.</p>

<div class="code-block">
<div class="code-header">terminal</div>
<pre><code><span class="cmd-comment"># Write secrets to .env file</span>
manup secrets export --out .env
<pre><code><span class="cmd-comment"># Write secrets to .env file by environment name</span>
manup secrets export -e prod --out .env

<span class="cmd-comment"># Output shell export format</span>
manup secrets export -e dev --format export

<span class="cmd-comment"># Output JSON format</span>
manup secrets export --format json</code></pre>
manup secrets export -e staging --format json</code></pre>
</div>
</section>

Expand All @@ -804,11 +840,16 @@ <h2>🚀 Running Commands (<code>manup run</code>)</h2>

<div class="code-block">
<div class="code-header">terminal</div>
<pre><code><span class="cmd-comment"># Inject secrets into Node.js application</span>
<pre><code><span class="cmd-comment"># Inject secrets into Node.js application (linked environment)</span>
manup run -- node server.js

<span class="cmd-comment"># Inject secrets into npm dev server</span>
manup run -- npm run dev</code></pre>
manup run -- npm run dev

<span class="cmd-comment"># Switch environment on the fly by name</span>
manup run -e dev -- npm start
manup run -e prod -- npm test
manup run -p backend -e staging -- npm run build</code></pre>
</div>
</section>

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "manup-cli",
"version": "0.2.0",
"version": "0.3.0",
"description": "Official CLI for ManUp Secrets Vault (https://github.com/Amanbig/ManUp) — Manage, synchronize, and inject environment secrets seamlessly across projects.",
"type": "module",
"main": "./dist/index.js",
Expand Down
Loading
Loading