Octrafic

Appearance

Project Management ​

Octrafic offers flexible project management to suit different workflows - from quick one-off tests to persistent, reusable projects.

Project Types ​

Temporary Projects ​

Quick tests that don't need to be saved. Perfect for exploring new APIs or one-time debugging.

bash
# Create a temporary project
octrafic -u https://api.example.com -s spec.json

# Project is stored in /tmp/octrafic-projects/
# Automatically cleaned up on system restart

When to use:

  • Testing a new API for the first time
  • Quick debugging session
  • Exploring public APIs
  • One-off API calls

Named Projects ​

Persistent projects saved for future use. Ideal for APIs you work with regularly.

bash
# Create a named project
octrafic -u https://api.example.com -s spec.json -n "Production API"

# Project is saved to ~/.octrafic/projects/
# Can be reopened anytime

When to use:

  • Development APIs you test regularly
  • Production APIs for monitoring
  • Client APIs you integrate with
  • Any API you'll use more than once

Working with Projects ​

Creating a Project ​

bash
# Temporary (no name)
octrafic -u https://jsonplaceholder.typicode.com -s spec.json

# Named (saved)
octrafic -u https://api.stripe.com -s stripe.json -n "Stripe API"

Loading a Project ​

By name:

bash
octrafic -n "Stripe API"

From interactive list:

bash
octrafic

# You'll see:
# Select a Project
#
# Press '/' to search
#
# ▶ Stripe API
#   https://api.stripe.com • Last used: 2 hours ago
#
#   GitHub API
#   https://api.github.com • Last used: yesterday
#
# ↑/k up • ↓/j down • enter select • / search • q quit

Navigation:

  • ↑/↓ or j/k - Navigate through projects
  • / - Start searching
  • Enter - Select project
  • Esc - Cancel search
  • q - Quit

Updating a Project ​

bash
# Update existing project with new spec or URL
octrafic -u https://api.example.com -s new-spec.yaml -n "Production API"

# You'll be prompted:
# ⚠️  Project 'Production API' already exists.
#    Current URL: https://api.example.com
#    Current Spec: old-spec.yaml
#
# Update with new configuration? (y/N):

Project Storage ​

Named projects are saved in:

~/.octrafic/projects/{project-uuid}/

Temporary projects are saved in:

/tmp/octrafic-projects/{project-uuid}/

Each project contains:

  • project.json - Project metadata (URL, spec path, auth config, timestamps)
  • spec.bleve/ - Search index for AI-powered endpoint discovery
  • spec.hash - Spec file hash for cache invalidation

Best Practices ​

Use clear, descriptive project names and keep your spec files in version control when possible. Once indexed, projects work without the spec file.