Skip to Content
DocsQuick Start (CLI)

Quick Start: CLI

Get your first Feelr request working from the terminal. The CLI talks to the Feelr gateway and formats responses for humans and scripts alike.

1. Install

Pick your preferred method — all four are equally supported:

Homebrew

brew install progradetech/feelr/feelr

Shell Script

curl -fsSL https://get.feelr.dev | sh

Go Install

go install github.com/progradetech/feelr/cli@latest

GitHub Releases

Download the binary for your platform from GitHub Releases .

2. Initialize

Point the CLI at your Feelr gateway:

feelr init
Enter your Feelr gateway URL: https://api.feelr.dev Enter your API key: fk_live_abc123... Config written to ~/.config/feelr/config.toml

3. Store Credentials

Authenticate with a connector. For GitHub, you’ll provide a Personal Access Token:

feelr auth github
Enter your GitHub Personal Access Token: ghp_... Credential stored for github.

4. Make Your First Request

feelr run github repos.list
[ { "id": 123456, "name": "my-project", "full_name": "you/my-project", "private": false, "description": "A cool project", "language": "TypeScript" } ]

5. Pass Parameters

Use key=value pairs after the action name:

# List open issues feelr run github issues.list repo=owner/repo state=open # Create an issue feelr run github issues.create repo=owner/repo title="Bug report" labels=bug

6. Discover Actions

See what’s available:

# List all connectors and their actions feelr tools # Search for specific actions feelr tools --search issues
github issues.list Lists issues for a repository issues.get Gets a single issue by number issues.create Creates a new issue issues.update Updates an existing issue issues.close Closes an issue

7. Check Gateway Status

feelr status
Gateway: https://api.feelr.dev Status: healthy Version: 0.1.0 Connectors: github 4 actions connected slack 6 actions connected stripe 8 actions not connected discord 7 actions not connected

Output Formats

The CLI outputs unwrapped JSON data by default. Use flags to change this:

# Full envelope with metadata feelr run github repos.list --verbose # Raw upstream response (no normalization) feelr run github repos.list --format=raw

Pagination

Pass --cursor for paginated results:

feelr run github repos.list --cursor=2

Configuration

Config lives at ~/.config/feelr/config.toml:

[default] gateway = "https://api.feelr.dev" api_key = "fk_live_abc123..."

Use profiles for multiple environments:

[staging] gateway = "https://staging.feelr.dev" api_key = "fk_test_def456..."
feelr run github repos.list --profile=staging

Exit Codes

CodeMeaning
0Success
1Error (general)
2Auth required
3Not found
4Usage error

Next Steps

Last updated on