hello-ralph
v2.0.2
Published
Interactive CLI to learn about Ralph
Maintainers
Readme
Hello Ralph
Interactive CLI to learn about Ralph.
View and export JSON Resume–style CVs from the terminal.
Install
npm install -g hello-ralphNode 18+ is required.
Usage
Run this CLI using the command hello-ralph (or simply halph) to access Ralph's resume.
You can also make it your own by loading your own resume based on this schema
(inspired by jsonresume.org). Start by seeing what's possible:
halph --helpSee all sections
Run without arguments to display all resume sections:
halphSelect specific section
Display a single section using the -e or --entry flag:
halph -e contact
halph -e skills
halph -e projectsAvailable sections: contact, jobs, education, skills, projects, languages, references
Interactive mode
Use -e without a value to enter interactive mode and select multiple sections:
halph -eThis will prompt you to select one or more sections using checkboxes (use space to select, enter to confirm).
Custom resume source
Load resume data from a different file or URL:
halph -s path/to/resume.json
halph -s data/resume.yaml -e contact
halph -s https://example.com/resume.jsonCaching behavior:
- When a source is explicitly provided (
-s), it loads from that source and updates the cache. - When no source is provided, it uses the cache if available, otherwise falls back to the bundled default (
bin/resume.json). - Cache is always saved as JSON, regardless of source format.
Output format
Change the output format:
halph -f json
halph -f yaml
halph -f prettyAI chat mode
Ask questions about the resume in a conversational way. The assistant only answers questions related to the loaded resume data (from source or cache). Off-topic questions are politely declined.
| Variable | Description |
| ----------------- | ----------------------------------------- |
| OPENAI_API_KEY | set OpenAI API key (required) |
| OPENAI_MODEL | set OpenAI model (default: gpt-4o-mini) |
| OPENAI_BASE_URL | use for custom/proxy endpoints |
export OPENAI_API_KEY=sk-...
halph --chat
# or with a custom source
halph --chat -s https://example.com/resume.jsonIf OPENAI_API_KEY is missing, the CLI prints an error and exits. Type exit, quit, or q (or Ctrl+C)
to end the conversation.
Save to file
Write output to a file:
halph -o resume.txt
halph -e contact -f json -o contact.json
halph -e skills -f yaml -o skills.yamlCLI options
| Flag | Description |
| ----------------------------------- | ---------------------------------------------------------------------- |
| -v, --version | Show version number |
| -o, --output <path> | Write output to file |
| -f, --format <pretty\|json\|yaml> | Output format (default: "pretty") |
| -e, --entry [section] | Print specific section(s). Use without value to enter interactive mode |
| -s, --source <path\|url> | Path to local JSON/YAML file or URL to fetch resume from |
| -c, --chat | start AI chat mode (powered by OpenAI) |
| -h, --help | Show help message |
Examples
# Display all sections
halph
# Display contact information only
halph -e contact
# Interactive mode - select multiple sections
halph -e
# Load from custom file and display skills
halph -e skills -s my/resume.json
# Export contact info as JSON
halph -e contact -f json -o contact.json
# Load from URL and display projects
halph -e projects -s https://example.com/resume.json
# AI chat about the resume (requires OPENAI_API_KEY)
halph --chat
halph --chat -s my/resume.jsonLocal development
npm install
npm run cli
npm run cli -- -e contactOr link globally: npm link then run halph from anywhere.
