getting-started.md

Getting Started with Junie Orchestrator

Prerequisites

Before you can use Junie Orchestrator, you need to ensure that Junie CLI is properly authenticated.

Authentication Required for Junie CLI

The Junie Orchestrator uses Junie CLI to execute tasks. Before the orchestrator can work, Junie CLI must be authenticated.

What You Need to Do

You must authenticate Junie CLI before running any tasks. You have three options:

Option 1: Interactive Setup (Recommended)

Run Junie in interactive mode:

junie

Option 2: Use the --auth Flag

Provide your API key directly:

junie --auth your_api_key

Option 3: Set Environment Variable

Export your API key as an environment variable:

export JUNIE_API_KEY=your_api_key

Getting Your API Key

Visit https://junie.labs.jb.gg/cli to generate an API key.

Important Notes

• Authentication only needs to be done once. After that, all future Junie Orchestrator runs will work automatically.
• If you see authentication instructions instead of task execution results, it means Junie CLI is not yet authenticated.

Next Steps

Once Junie CLI is authenticated:

1. Set your OpenAI API key (required for the orchestrator):

   export OPENAI_API_KEY=your_openai_api_key

2. Run the Junie Orchestrator with your task:

   junie-orchestrator "your task description" --repo-url https://github.com/your/repo

3. The orchestrator will:

   • Create a working directory and Git branch for your task
   • Generate acceptance criteria
   • Execute Junie commands iteratively
   • Review changes with GPT until the task is complete

For more detailed information about installation and usage, see the README.md file.