Skip to content

Installation

Install and configure the iflow command-line tool.

Requirements

  • Python 3.11 or higher
  • pip or uv package manager

Install from PyPI

pip install intelliseq-iflow

Or with uv:

uv pip install intelliseq-iflow

Verify Installation

iflow --version

For first-time setup, use the interactive wizard:

iflow configure

This guides you through:

  1. Environment selection — Choose Production or Staging
  2. Authentication — Opens browser for OAuth login
  3. Project selection — Pick your default working project

After setup, verify everything works:

iflow status
iflow config show

Authentication

Interactive Login (Device Flow)

iflow login

This opens your browser for authentication. On headless environments, a clickable URL is displayed.

Login with Personal Access Token

For CI/CD or headless environments, use a PAT:

iflow login --token YOUR_PAT

Or set as environment variable:

export IFLOW_TOKEN=YOUR_PAT
iflow login

Check Login Status

iflow status

Output: 

Logged in as: your@email.com
Token expires: 2026-01-08 14:30:00

Logout

iflow logout

Configuration

View Current Settings

iflow config show

Set API Endpoints

For production:

iflow config set api_url https://files.iflow.intelliseq.com
iflow config set compute_url https://compute.iflow.intelliseq.com

For development:

iflow config set api_url http://localhost:8002
iflow config set compute_url http://localhost:8005

Configuration File

Settings are stored in ~/.config/iflow/config.json:

{
  "api_url": "https://files.iflow.intelliseq.com",
  "compute_url": "https://compute.iflow.intelliseq.com"
}

Environment Variables

Variable Description Default
IFLOW_TOKEN Personal Access Token for auth -
IFLOW_FILE_URL File service URL -
IFLOW_COMPUTE_URL Compute service URL -
IFLOW_ADMIN_URL Admin service URL -
IFLOW_MINER_URL Miner service URL -

Environment variables override config file settings.

Security Notes

Token Storage:

  • On desktop systems, tokens are stored in your system's secure keyring (macOS Keychain, GNOME Keyring, Windows Credential Manager)
  • On headless servers without a keyring, tokens are stored in ~/.local/share/python_keyring/ - ensure this directory has restricted permissions (chmod 700)

Token Authentication:

  • Use --token or IFLOW_TOKEN for CI/CD with secrets management
  • Prefer Device Flow (iflow login) for interactive use — it doesn't expose credentials

Next Steps