> ## Documentation Index
> Fetch the complete documentation index at: https://docs.banya.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Sign in

> How to sign in to CodePilot IDE, broken down by authentication method.

After installation, click the CodePilot icon in the activity bar to bring up the sign-in screen in the chat panel.

<img src="https://mintcdn.com/banyaai/eM-Nuqr2SnMxEdsc/images/en/IDE_LOGIN.png?fit=max&auto=format&n=eM-Nuqr2SnMxEdsc&q=85&s=86b85b6bec7a8da3b443a384d75d8765" alt="Sign-in screen" width="497" height="1012" data-path="images/en/IDE_LOGIN.png" />

What the sign-in screen looks like depends on the **authentication method** your organization uses. If you're not sure which one applies, ask your organization administrator.

| Authentication method | Sign-in screen                      | Where it's typically used                       |
| --------------------- | ----------------------------------- | ----------------------------------------------- |
| **Social login**      | Google · GitHub · Microsoft buttons | Cloud (SaaS) default                            |
| **Username/password** | Email · password entry form         | On-premises                                     |
| **License key**       | License key registration            | Standalone environments used without signing in |

***

## Social login (default)

<Steps>
  <Step title="Click the sign-in button">
    Click the **Sign in with Google** button. Depending on your organization's configuration, GitHub and Microsoft buttons may also appear.
  </Step>

  <Step title="Authenticate in the browser">
    Your default browser opens and shows the account authentication screen. Once you complete authentication, you'll see the message **"Signed in — return to VS Code to continue working."**
  </Step>

  <Step title="Return to VS Code">
    Back in VS Code, the sign-in screen disappears and the chat panel becomes active.
  </Step>
</Steps>

<Tip>
  If you choose **Sign in with GitHub**, an authentication code is shown instead of opening a browser. The code is copied to your clipboard automatically, so you just paste it into the open GitHub page.
</Tip>

***

## Username/password sign-in (on-premises)

In on-premises deployments, the sign-in screen shows an email and password entry form.

<img src="https://mintcdn.com/banyaai/eM-Nuqr2SnMxEdsc/images/en/IDE_LOGIN_LOCAL.png?fit=max&auto=format&n=eM-Nuqr2SnMxEdsc&q=85&s=a1c5c5928d118acdfc9739a984a29fe9" alt="Username/password sign-in" width="490" height="1018" data-path="images/en/IDE_LOGIN_LOCAL.png" />

* **Sign in** — Enter the email and password you were issued.
* **Sign up** — If you don't have an account, click **"Don't have an account? Sign up"** and register with your name, email, and password.

<Info>
  If you forget your password, contact your organization administrator. The administrator issues a **temporary password** from the Admin console. Sign in with the temporary password you receive, then change your password.
</Info>

***

## License key registration (standalone)

In environments that use AI models registered directly without a backend server, you register a **license key** instead of signing in.

<img src="https://mintcdn.com/banyaai/eM-Nuqr2SnMxEdsc/images/en/IDE_LOGIN_LICENSE.png?fit=max&auto=format&n=eM-Nuqr2SnMxEdsc&q=85&s=47bef67511c016b130d656d0ab227935" alt="License key registration" width="495" height="1013" data-path="images/en/IDE_LOGIN_LICENSE.png" />

<Steps>
  <Step title="Open the Command Palette">
    `Ctrl+Shift+P` (macOS: `Cmd+Shift+P`)
  </Step>

  <Step title="Register the license key">
    Run **CodePilot: Register License Key** and select the license key file you received.
  </Step>

  <Step title="Register AI models">
    In Settings → **AI Models**, register the models and API keys you want to use.
  </Step>
</Steps>

***

## Server address configuration

In on-premises environments, you must first specify the server address to connect to. In VS Code Settings (`Ctrl+,`), search for `codepilot` and enter the following items.

| Setting         | Description                                                           | Default                                 |
| --------------- | --------------------------------------------------------------------- | --------------------------------------- |
| **Backend URL** | Your organization's server address                                    | `https://api-codepilot.banya.ai/api/v1` |
| **Auth Mode**   | Authentication method (social login / username-password / standalone) | Social login                            |

<Tip>
  If you use the cloud (SaaS) service, **leave the defaults as they are.** In on-premises environments, administrators often set these values in advance at deployment time — if the sign-in screen appears correctly, don't change anything.
</Tip>

***

## Signing out

Run **CodePilot: Sign Out** from the Command Palette, or click the **Sign out** button in Settings → **Account** tab.

***

## Next steps

<Card title="Connect an AI model" icon="key" href="/en/getting-started/ai-model">
  Choose an AI model, or register your own API key, and start using it right away
</Card>