Skip to content

Commit

Permalink
add cli intro
Browse files Browse the repository at this point in the history
  • Loading branch information
jxnl committed Sep 6, 2023
1 parent 3e765d1 commit f88dfcc
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 2 deletions.
35 changes: 35 additions & 0 deletions docs/cli/index.md
Original file line number Diff line number Diff line change
@@ -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)
5 changes: 3 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit f88dfcc

Please sign in to comment.