mirror of
https://github.com/kennethreitz/instructor.git
synced 2026-06-05 22:50:18 +00:00
add cli intro
This commit is contained in:
@@ -0,0 +1,35 @@
|
||||
# Instructor CLI
|
||||
|
||||
Welcome to the Instructor Command-Line Interface (CLI), a tool designed to ease your experience with the OpenAI API. Whether it's tracking your API usage or fine-tuning your models, Instructor CLI is your go-to utility.
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
First things first: make sure your OpenAI API key is set as an environment variable. The CLI will use this for authenticating your requests to OpenAI's services.
|
||||
|
||||
You can set the API key in your terminal as follows:
|
||||
|
||||
```bash
|
||||
export OPENAI_API_KEY="your-api-key-here"
|
||||
```
|
||||
|
||||
## Installation & Setup
|
||||
|
||||
```bash
|
||||
pip install instructor
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
- **API Usage Monitoring**: Keep tabs on your API usage right from the terminal. Track token counts, total requests, and even calculate the costs. To learn more, consult the [Usage Guide](usage.md).
|
||||
|
||||
- **Model Fine-Tuning**: Optimize your models to meet your specific requirements using our fine-tuning app. For more details, check out the [Fine-Tuning Guide](finetune.md).
|
||||
|
||||
---
|
||||
|
||||
## Support & Contribution
|
||||
|
||||
Need help or want to contribute? Visit our [GitHub Repository](https://github.com/jxnl/instructor)
|
||||
+3
-2
@@ -64,8 +64,9 @@ nav:
|
||||
- "Introduction: Writing Prompts": "writing-prompts.md"
|
||||
- "Prompting Templates": "chat-completion.md"
|
||||
- CLI Reference:
|
||||
- "Usage": "cli/usage.md"
|
||||
- "Finetuning": "cli/finetune.md"
|
||||
- "Introduction": "cli/index.md"
|
||||
- "Usage Tracking": "cli/usage.md"
|
||||
- "Finetuning GPT": "cli/finetune.md"
|
||||
extra:
|
||||
analytics:
|
||||
provider: google
|
||||
|
||||
Reference in New Issue
Block a user