Instructor CLI Tools¶
-
Command Line Utilities
Powerful tools to enhance your Instructor workflow
-
Usage Monitoring
Track API usage, costs, and token consumption
-
Model Fine-Tuning
Create and manage custom model versions
-
Documentation Access
Quickly access docs from your terminal
Getting Started¶
Installation¶
The CLI tools are included with the Instructor package:
API Setup¶
Set your OpenAI API key as an environment variable:
Available Commands¶
Instructor provides several command-line utilities:
Command | Description | Guide |
---|---|---|
instructor usage | Track API usage and costs | Usage Guide |
instructor finetune | Create and manage fine-tuned models | Fine-Tuning Guide |
instructor docs | Quick access to documentation | See below |
Usage Command¶
Monitor your OpenAI API usage directly from the terminal:
# View total usage for the current month
instructor usage
# View usage breakdown by day
instructor usage --by-day
# Calculate cost for a specific model
instructor usage --model gpt-4
For detailed usage statistics and options, see the Usage Guide.
Fine-Tuning Command¶
Create and manage fine-tuned models with an interactive interface:
This launches an interactive application that guides you through the fine-tuning process. Learn more in the Fine-Tuning Guide.
Documentation Command¶
Quickly access Instructor documentation from your terminal:
# Open main documentation
instructor docs
# Search for specific topic
instructor docs validation
# Open specific page
instructor docs concepts/models
This command opens the Instructor documentation in your default web browser, making it easy to find information when you need it.
Support & Contribution¶
- GitHub: Visit our GitHub Repository
- Issues: Report bugs or request features on our Issue Tracker
- Discord: Join our Discord Community for support