# Getting Started

import { Steps, Aside } from '@astrojs/starlight/components';

Migrating to Avrea is a one-line change in your workflow file. No other changes
are required. Caching, observability, and infrastructure are handled automatically.

<Steps>

1. **Install the Avrea GitHub App**

   Sign in at [console.avrea.com](https://console.avrea.com), create or select
   an Avrea organization, then click **Install Avrea app**. GitHub will ask
   which account or organization to install on, then whether to grant access
   to all repositories or only a selection. Pick all your repos or just one
   to try it out; you can always add more later.

   <Aside title="Not a GitHub org owner?">
   If your organization requires owner approval for GitHub App installations, the
   install completes as a pending request. The Avrea console shows a pending
   approval screen. Share it with an owner of your GitHub organization, who can
   approve the request from the organization's [installed apps settings](https://docs.github.com/en/apps/using-github-apps/requesting-a-github-app-from-your-organization-owner).
   </Aside>

2. **Duplicate your workflow**

   Create a copy of your existing workflow file and update the runner:

   ```yaml title="workflow.yml" del={3} ins={4}
   jobs:
     build:
       runs-on: ubuntu-latest
       runs-on: avrea-ubuntu-latest
   ```

   Keep your original workflow unchanged so you can compare results side by side.
   `avrea-ubuntu-latest` matches GitHub's default (2 vCPUs, 8 GB RAM). For
   larger VM sizes, see [Runners & Pricing](/runners/).

   If you lint your workflow files with actionlint, it also needs to learn the
   new label. See [Linting your workflows](/runners/#linting-your-workflows).

3. **Trigger both workflows**

   Run each workflow and compare Avrea with your existing setup. Run it
   **twice**: the first run shows the hardware speedup and the second run
   is where the cache kicks in for a much larger improvement.

</Steps>

<Aside>
Avrea currently supports GitHub Actions. Other CI platforms will be added later.
</Aside>

## Next steps

- **[Cache](/cache/overview/)**: transparent acceleration for GitHub Actions cache, build caches, and package managers.
- **[Debugging & SSH](/debugging/)**: SSH into a running job from the console or the CLI.
- **[Observability](/observability/)**: step-level logs, run history, and failure/flake analytics.

## Need help?

Reach out at [support@avrea.com](mailto:support@avrea.com) for onboarding
questions, technical issues, or product feedback. Or join the
[Avrea Slack community](https://join.slack.com/t/avreacommunity/shared_invite/zt-3x9zjxpit-2LkP_QTHs5iFMau2DEsc7g).