Sign up & connect GitHub

Soxom is a hosted service. There is no CLI to install and nothing to run on your machine — everything happens in the Soxom dashboard and the GitHub repositories it manages on your behalf.

To start using Soxom you need to do two things: create an account, and install the Soxom GitHub App on the GitHub organization (or personal account) that will own your Config Repository.

Prerequisites

• A GitHub account.
• An organization on GitHub if you want SDKs to live under an org rather than your personal account.
• An OpenAPI 3.0 or 3.1 specification for your API (you can also start from the template Soxom creates for you).

Steps

1. Sign up at the Soxom dashboard

   Open app.soxom.dev and create an account. Soxom uses WorkOS for authentication, so you can sign in with email, Google or Microsoft OAuth, or your company’s SSO provider if your org has it configured.

   On first sign-in you’ll be placed into a new Organization. If you’ve been invited to an existing one, accept the invite from your email.

2. Install the Soxom GitHub App

   From the dashboard, click Connect GitHub. You’ll be redirected to GitHub to authorize the Soxom GitHub App.

   GitHub will ask you to choose where to install the app:

   • An organization — recommended for team or company SDKs. You may need an org admin to approve.
   • Your personal account — fine for prototypes and personal projects.

   You can grant the app access to all repositories or only select repositories. If you choose “select”, make sure to include any existing repo you want Soxom to read; Soxom will also create new repositories under the chosen account when you add SDK targets.

3. Confirm the connection

   After authorizing, you’ll be redirected back to the Soxom dashboard. The connected GitHub account or org will appear on your settings page. You’re now ready to create your first project.

Note

Soxom needs permission to create repositories, open pull requests, push branches, and read commits on the repos it manages. It never reads code from repositories you haven’t selected.

What Soxom does not require

• No local CLI. Soxom does not ship a CLI tool — generation runs server-side.
• No Docker on your machine. Generators run in Soxom’s infrastructure.
• No language runtimes. You don’t need Python, Node, or a JDK installed locally to produce SDKs in those languages.

Next steps

• Quick Start — create your first project and ship a release.
• How Soxom works — see what happens after you push to your Config Repository.