Quickstart
==========

Get up and running with SpecAlign in 5 minutes.

Overview
--------

In this quickstart, you will:

1. Initialize the configuration
2. Set up your API credentials
3. Run a simple red-team test
4. View the generated results

Prerequisites
-------------

- SpecAlign installed (see :doc:`installation`)
- OpenAI API key or compatible provider

Step 1: Initialize Configuration
--------------------------------

Create default configuration files:

.. code-block:: bash

   specalign config init

This creates two files:

- ``config.json`` - Main configuration
- ``providers.json`` - API provider settings

Step 2: Set API Credentials
---------------------------

Option A: Environment Variable
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: bash

   export SPECALIGN_OPENAI_API_KEY="sk-your-api-key"

Option B: Edit providers.json
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: json

   {
     "providers": {
       "openai": {
         "base_url": "https://api.openai.com/v1",
         "api_key": "sk-your-api-key"
       }
     }
   }

Step 3: Run the Pipeline
------------------------

Run the complete SpecAlign pipeline:

.. code-block:: bash

   specalign run --config config.json

Expected Output
---------------

You should see progress output similar to:

.. code-block:: text

   SpecAlign Pipeline
   ==================

   Phase 1: Specification Generation
   ---------------------------------
   ✓ Loading rules from data/Stage_classified.md
   ✓ Generated 10 specifications
   ✓ Generated 100 seed prompts

   Phase 2: Red Team Testing
   -------------------------
   Processing seeds: 100%|██████████| 100/100 [05:23<00:00]
   ✓ Completed 100 episodes
   ✓ Found 42 successful attacks
   ✓ Generated 42 DPO pairs

   Results saved to:
   - output/episodes.jsonl
   - output/dpo_dataset.json
   - output/context_pool.jsonl

Step 4: View Results
--------------------

Analyze the generated data:

.. code-block:: bash

   specalign analyze output/

Output Files
------------

.. list-table::
   :header-rows: 1

   * - File
     - Description
   * - ``seeds.json``
     - Generated seed prompts
   * - ``episodes.jsonl``
     - Full adversarial episode logs
   * - ``dpo_dataset.json``
     - DPO preference pairs for training
   * - ``context_pool.jsonl``
     - Successful attack examples

Next Steps
----------

- :doc:`first_experiment` - Deep dive into red-team testing
- :doc:`../tutorials/red_team_pipeline` - Complete pipeline tutorial
- :doc:`../user_guide/configuration` - Configuration reference