Skip to main content

Secryn CLI — manage your secrets from the terminal

Project description

Secryn CLI

PyPI Python License

Command-line interface for Secryn — manage your secrets, projects, and API keys without leaving the terminal.

Installation

Via pipx (recommended)

pipx install secryn-cli

From source

cd packages/cli
pipx install -e .

Via pip + venv

cd packages/cli
python3 -m venv .venv
.venv/bin/pip install -e .
ln -sf $(pwd)/.venv/bin/sc ~/.local/bin/sc

One-liner install script

curl -fsSL https://raw.githubusercontent.com/P4ciuf/secryn/main/packages/cli/install.sh | bash

Requires Python 3.10+.

Quick Start

# Login to your Secryn instance
sc auth login --email user@example.com --password "your-password"

# Or use a custom API URL
sc --api-url https://api.secryn.xyz/api/v1 auth login

The CLI stores configuration and session cookies in ~/.config/secryn/.

Commands

Authentication

sc auth login                                   # Interactive login
sc auth login --email <email> --password <pw>   # Non-interactive
sc auth logout                                  # Logout and clear cookies
sc auth whoami                                  # Show authenticated user
sc auth whoami --json                           # JSON output

Projects

sc projects list                        # List all projects
sc projects list --json                 # JSON output
sc projects create --name <name>        # Create a project
sc projects create --name <name>        # With description
  --description <desc>
sc projects delete --id <id>            # Delete (with confirmation)
sc projects delete --id <id> -f         # Skip confirmation

Secrets

sc secrets list --project-id <id>             # List secrets
sc secrets list --project-id <id> --json      # JSON output
sc secrets get --id <id>                      # Show secret (masked)
sc secrets get --id <id> --show-value         # Show in plain text
sc secrets get --id <id> --json               # JSON output
sc secrets create --project-id <id>           # Create a secret
  --name <name> --value <value>
  --notes <notes>                             # Optional notes
sc secrets update --id <id>                   # Partial update
  --name <new> --value <new>
  --notes <new>
sc secrets delete --id <id>                   # Delete secret
sc secrets delete --id <id> -f                # Skip confirmation
sc secrets export --project-id <id>           # Export as .env (stdout)
sc secrets export --project-id <id>           # Export to file
  -o .env

API Keys

sc api-keys list                        # List all keys
sc api-keys list --json                 # JSON output
sc api-keys create --name <name>        # Create key (read+write)
sc api-keys create --name <name>        # Create with specific permissions
  --permissions read
sc api-keys delete --id <id>            # Delete key
sc api-keys delete --id <id> -f         # Skip confirmation

User & Config

sc user info                # Show user profile
sc config                   # Show config paths and values
sc version                  # Show CLI version

Global Options

Option Description
--api-url <url> Override API base URL (default: http://localhost:3000)
--json Output in JSON format (where supported)
--force, -f Skip confirmation for destructive commands
--help Show help for any command or subcommand

Environment Variables

Variable Description
SECRYN_API_URL Alternative to --api-url
SECRYN_HOME Custom config directory

Configuration Files

The CLI stores its state in ~/.config/secryn/:

File Content
config.json API URL, user ID, email
cookies.json JWT session cookies (httpOnly)

License

Apache 2.0 — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

secryn_cli-0.1.1.tar.gz (17.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

secryn_cli-0.1.1-py3-none-any.whl (18.0 kB view details)

Uploaded Python 3

File details

Details for the file secryn_cli-0.1.1.tar.gz.

File metadata

  • Download URL: secryn_cli-0.1.1.tar.gz
  • Upload date:
  • Size: 17.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for secryn_cli-0.1.1.tar.gz
Algorithm Hash digest
SHA256 6503ba96f8e29679dcd23dc9fd171a18a77cf2502157868b809edde49e019657
MD5 967359a0db371d2bbe4d8ea77f495492
BLAKE2b-256 0e6d8d2bed4dd1d566d48b461db1b8a9ceceb6fc1ee95e0a105d3fa841598f19

See more details on using hashes here.

Provenance

The following attestation bundles were made for secryn_cli-0.1.1.tar.gz:

Publisher: publish-cli.yaml on P4ciuf/secryn

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file secryn_cli-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: secryn_cli-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 18.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for secryn_cli-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3e62bea58e82186c3816ac9f5c6b2fb9021544c8dace5860e32869fa38e893be
MD5 c350e0f767dd27ad59b943272f61af9f
BLAKE2b-256 141c76cfa1056e21035bb71b0e78b90cc98e3c31b1cff28e045aa43581c4cd09

See more details on using hashes here.

Provenance

The following attestation bundles were made for secryn_cli-0.1.1-py3-none-any.whl:

Publisher: publish-cli.yaml on P4ciuf/secryn

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page