CLI Tool

restume-cli is the official command-line tool for RESTume. Manage your profile, import resumes, check analytics, and handle billing — all from the terminal. Outputs structured JSON, YAML, or TSV for easy scripting and CI/CD integration.

Owner control plane

Edit profile data, themes, layout, security logs, resume state, transcripts, exports, and billing from the same owner APIs the portal documents.

Automation-ready

Use structured output, machine-readable help, skeleton generation, file/stdin input, and profile-aware auth contexts for scripts and agents.

Operator workflows

Run admin support, KPI, entitlement, blog publishing, and re-embed commands without screen-scraping the dashboard or guessing server state.

Install Quick Start Examples Authentication Automation Commands Configuration

Installation

From GitHub

$ pip install "restume-cli @ git+https://github.com/HershelT/RESTume.git#subdirectory=cli"
$ pipx install "restume-cli @ git+https://github.com/HershelT/RESTume.git#subdirectory=cli"

From source

$ git clone https://github.com/HershelT/RESTume.git
$ cd RESTume/cli
$ pip install -e ".[dev]"

Quick Start

# 1. Sign in and store a JWT session

$ restume-cli auth login

# 2. Inspect your account and sign-in state

$ restume-cli account show

# 3. Create an API key only when you need owner automation

$ restume-cli api-key create --name ci

# 4. Manage owner data

$ restume-cli profile show

$ restume-cli theme show

$ restume-cli resume import resume.pdf --yes

# 5. Verify your environment and server capabilities

$ restume-cli doctor

Examples

Profile and resume workflow

# Sign in, inspect your profile, then import a resume

$ restume-cli auth login

$ restume-cli profile show

$ restume-cli resume import resume.pdf --yes

$ restume-cli skills list

$ restume-cli profile update --open-to-work

Themes, layout, analytics, and transcripts

# Inspect presentation state and owner analytics

$ restume-cli theme show

$ restume-cli layout show

$ restume-cli insights show

$ restume-cli transcripts list --channel web

$ restume-cli export transcripts --server-format csv --output transcripts.csv

Billing, account, and security

# Check plan truth and account state

$ restume-cli account show

$ restume-cli billing show

$ restume-cli billing checkout --annual

$ restume-cli security events

$ restume-cli doctor --output json

Automation and admin operations

# Generate command metadata, drive mutations from files, and run admin tasks

$ restume-cli help --json

$ restume-cli profile update --from-file profile.yaml

$ restume-cli layout set --generate-skeleton yaml-input

$ restume-cli admin support show hershel

$ restume-cli admin entitlement grant hershel --reason "Launch support"

$ restume-cli admin blog create --title "Launch Notes" --summary "Production recap" --content-file post.md

$ restume-cli admin blog import --from-file blog-posts.json

Authentication

Interactive login

Stores a validated JWT session only. No API key is created automatically.

$ restume-cli auth login

Direct credentials

Validate and store a JWT or API key in a named profile.

$ restume-cli auth login --jwt eyJ...
$ restume-cli auth login --token rst_abc123...

Session-aware account flows

Account recovery and linked-auth lifecycle are first-class commands.

$ restume-cli auth forgot-password --email you@example.com
$ restume-cli account unlink-google --yes

Admin commands require a stored JWT session. Owner API keys remain scoped to owner automation and are not used for admin ... workflows.

Automation Features

Structured output and help

Prefer canonical machine-readable surfaces for CI, scripting, and agent tooling. Structured output modes are JSON/YAML/TSV.

$ restume-cli help --json
$ restume-cli --output json skills list
$ restume-cli --output tsv insights show

Input skeletons and file-driven requests

Complex commands can emit canonical input skeletons and then consume JSON or YAML from files or stdin.

$ restume-cli profile update --generate-skeleton yaml-input
$ restume-cli layout set --from-file layout.yaml
$ restume-cli admin blog create --generate-skeleton yaml-input
$ cat theme.json | restume-cli theme set --stdin

Profiles and diagnostics

Multiple auth profiles, capability discovery, and environment diagnostics are built into the CLI contract.

$ restume-cli auth login --profile work
$ restume-cli --profile work doctor
$ restume-cli auth whoami

Canonical command names

The CLI exposes one supported command surface for humans, scripts, and agents.

Use auth login, auth logout, auth whoami, and auth status for session flows.

Use api-key ... for API key management.

Use resume import ... for resume ingestion.

Canonical Command Groups

Group	Purpose
`auth`	Register, login, verify email, resend verification, Google sign-in, forgot/reset password, logout, whoami, status.
`account`	Show account state and unlink Google safely.
`profile`, `skills`, `experience`, `education`, `projects`, `certifications`	Core owner CRUD.
`theme`, `layout`, `security`, `resume`	Presentation controls, security log, and resume maintenance.
`insights`, `transcripts`, `export`, `ask`	Analytics, transcript access, exports, and public AI questions.
`billing`	Billing summary, checkout, portal, and waitlist flows.
`api-key`, `config`, `doctor`, `completion`, `help`, `version`	Tooling, configuration, diagnostics, completions, and machine-readable help.
`admin`	KPI, support search/show, entitlement grant, admin blog publishing/import, and re-embed operations.

What you can do now

Manage the full owner profile surface: profile, resume state, theme, layout, insights, transcripts, exports, billing, and security events.
Use public AI queries with ask and authenticated owner/admin workflows from the same binary.
Script the CLI safely with JSON/YAML/TSV output, request diagnostics, machine-readable command metadata, and markdown-first admin blog publishing.

Good defaults

Interactive login stores a JWT session without auto-creating unused API keys.
Canonical command names are stable across human usage, scripts, and docs.
Owner and admin commands rely on documented JSON APIs instead of dashboard HTML fallbacks.

Configuration

Precedence

Resolution is explicit and stable: command flags, then environment, then profile config, then defaults.

$ restume-cli config set base_url https://restume.com
$ restume-cli config set default_username hershel
$ restume-cli config show

Environment variables

Variable	Description
`RESTUME_CLI_BASE_URL`	Server URL override.
`RESTUME_CLI_OUTPUT_FORMAT`	Default output format.
`RESTUME_CLI_DEFAULT_USERNAME`	Default username for public-facing commands.
`RESTUME_CLI_PROFILE`	Active auth profile override.
`RESTUME_API_KEY`	API-key override for automation.

See also: REST API docs · MCP Server · Auth Guide