CLI Quick Start

Overview

The f2d command-line tool lets you search for jobs directly from your terminal. Results are displayed as a formatted table by default.

Prerequisites

Bun >= 1.0 or Node.js >= 18.0
An API Key (contact the f2d team to obtain one)

Step 1: Install

bun install -g f2d-cli

Or with npm:

npm install -g f2d-cli

Don't want to install globally? Use bunx f2d-cli search "your query" to run without installing.

Step 2: Configure

Run the interactive setup — you only need your API key:

f2d configure

$ f2d configure
? API Key: ****
? Endpoint [https://...]: (press Enter to accept default)

Configuration saved to ~/.f2drc

The API endpoint is pre-configured with the default value. Just enter your API key and press Enter.

Step 3: Search

f2d search "machine learning engineer in Seattle" --top-k 3

You'll see a formatted table with job results:

Found 3 result(s):

┌─────────┬──────────────────────────────┬────────────────┬─────────┬───────────────────┬────────────┐
│ Score   │ Job Title                    │ Company        │ City    │ Salary            │ Published  │
├─────────┼──────────────────────────────┼────────────────┼─────────┼───────────────────┼────────────┤
│ 0.920   │ Machine Learning Engineer    │ Tech Corp      │ Seattle │ 150k-200k USD/YR  │ 2026-03-15 │
│ 0.850   │ ML Platform Engineer         │ AI Startup     │ Seattle │ 130k-170k USD/YR  │ 2026-03-10 │
└─────────┴──────────────────────────────┴────────────────┴─────────┴───────────────────┴────────────┘

More Examples

# Filter by city
f2d search "data scientist" --city "San Francisco" --top-k 5

# JSON output for piping
f2d search "Python developer" --format json | jq '.results[0]'

For all commands and options, see the CLI Reference.

Next Steps

See CLI Commands for all available commands and options
Learn about CLI Configuration for API key management and security