Sign in to Codewhale

What needs no account

You can use Codewhale today without signing in anywhere. These surfaces run on your machine with your own provider key or a local model:

• The terminal: run codewhale in a project folder.
• The local browser client: run codewhale web and use it in a browser tab on the same machine. See Open the browser client.
• Local work in the desktop app, which is a development build with no public download yet.

A provider key and a Codewhale account are separate. To connect a model, follow Connect a provider.

Sign in on the web

Open app.codewhale.net/login and choose how to continue: Continue with GitHub, Continue with Google, or Continue with email. For email, Codewhale sends a code or a link to your address, depending on how sign-in is set up; follow it to finish. The page needs JavaScript.

Note: The hosted browser app at app.codewhale.net is not open yet. Its sign-in page is live, and it is the page where you approve a sign-in that you started from the desktop app or the terminal.

Sign in from the desktop app

Note: The desktop app is a development build. There is no public download yet, and these steps describe the build as it stands today.

1. In the app, press Sign in. It appears in Settings, Account, and beside features that need an account.
2. Your browser opens the Codewhale approval page.
3. Read the page titled "Sign in to the Codewhale app?". It lists the app, the device and the account.
4. Continue only if you started this from the app a moment ago, then press "Sign in to the app". Press Cancel if you did not.
5. The page says you are signed in. Return to the app.

The approval page expires after 10 minutes. The app itself stops waiting after about 2 minutes and says "That took too long. Try again."; either way you start again from the app. Your folders, conversations and model keys stay on your computer either way.

Sign in from the terminal

Run the login command in any terminal:

codewhale login

1. The terminal prints a one-time code in the form XXXX-XXXX-XXXX and a link, then opens the link in your browser. Add --no-open to only print them.
2. On the approval page, check that the code matches the one in your terminal, then approve.
3. The terminal prints "Signed in to Codewhale."

The command waits for 10 minutes by default; --timeout-seconds changes that. Two more commands manage the session for the profile you are using:

codewhale account status

Shows which account this profile is signed in to, or says that it is not signed in.

codewhale account logout

Removes this profile's account session.

codewhale login is also available as codewhale account login. It never takes a provider key; those go through codewhale auth set.

Use a machine with no browser

On a server or in CI you cannot approve a sign-in in a browser. Use an account API key instead: set CODEWHALE_API_KEY to a key that starts with cwc_key_. You create the key from a signed-in terminal with codewhale account api-keys create --name <name>.

While CODEWHALE_API_KEY is set, commands that act for your whole account, such as cloud projects and agents, ask you to unset it and run codewhale login.

Sign in on a phone

The phone apps are not public yet, so there is nothing to sign in to on a phone today.

Sign out

Each surface ends only its own session, so signing out in one place does not sign you out of the others.

Desktop app

Press Sign out in Settings, Account, or press your name at the bottom of the sidebar and choose Sign out.

Terminal

Run codewhale account logout.

Web

Press Use another account on the signed-in page.

Note: codewhale logout is different: it removes every saved provider key and login, and asks you to confirm first. Use codewhale account logout to end only the account session.

Export your data or delete your account

Today you do this in one of two places. In the desktop app, open Settings, Account, Data & privacy. Press Export my data to save a copy, or Schedule account deletion to start deletion. After 30 days Codewhale can permanently delete the account, and you can cancel before deletion starts. Files on your computer stay there.

From any surface, you can also email help@codewhale.net and ask for an export or a deletion.

The full app guide

The step-by-step guide to the desktop app, including everything it shows when you sign in, is at docs.codewhale.net.

In source, not yet released

This section describes behavior that exists in the project's source and is not in the published release. Check which version you have with codewhale --version.

Next