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/feelrShell Script
curl -fsSL https://get.feelr.dev | shGo Install
go install github.com/progradetech/feelr/cli@latestGitHub Releases
Download the binary for your platform from GitHub Releases .
2. Initialize
Point the CLI at your Feelr gateway:
feelr initEnter your Feelr gateway URL: https://api.feelr.dev
Enter your API key: fk_live_abc123...
Config written to ~/.config/feelr/config.toml3. Store Credentials
Authenticate with a connector. For GitHub, you’ll provide a Personal Access Token:
feelr auth githubEnter 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=bug6. Discover Actions
See what’s available:
# List all connectors and their actions
feelr tools
# Search for specific actions
feelr tools --search issuesgithub
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 issue7. Check Gateway Status
feelr statusGateway: 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 connectedOutput 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=rawPagination
Pass --cursor for paginated results:
feelr run github repos.list --cursor=2Configuration
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=stagingExit Codes
| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | Error (general) |
| 2 | Auth required |
| 3 | Not found |
| 4 | Usage error |
Next Steps
- CLI Reference — all commands, flags, and exit codes
- Authentication — how API keys and credentials work
- GitHub Connector — full action reference
Last updated on