Quick Start

_{Note: find detailed docs at https://codespeak.dev/alpha_0.0.1}

Set up the CodeSpeak build process

• Configure BYOK for Anthropic
  • secret name: ANTHROPIC_API_KEY
  • generate your key with Anthropic Console
• Install CodeSpeak App
  • choose your repo from the list

Build your first app

• Edit your spec at spec/main.cs.md (you can do it from the GitHub UI)
  • the default template contains a spec for an example ToDo app in <!-- ... --> comments
  • uncomment it to try the example
• Look at the last commit
  • or Commit history for main.cs.md and see checks' status:
    
  • build status screen:
    

Run the code

When the build is finished, CodeSpeak will create a new commit in the repo with a message like "Implement Todoer personal Todo app with Django and Tailwind CSS". This commit adds the code generated by CodeSpeak.

To run this code, you need to

• either clone the repo locally,
• or use GitHub Codespaces.

You will need uv to run the code. To install uv, use these instructions. The shortcut command for most scenarios is:

curl -LsSf https://astral.sh/uv/install.sh | sh

Here are the steps to clone the repo locally:

git clone <repo URL>
cd <repo name>
uv sync
uv run python manage.py makemigrations
uv run python manage.py migrate
uv run python manage.py runserver

The server will display the URL to access the app (usually http://localhost:8000).

🎉 Congratulations! You've built your first app with CodeSpeak 🎉

Now, you can edit the spec and build again. For more guidance, see the docs at https://codespeak.dev/alpha_0.0.1.

P.S. Code Change Requests

If you find a bug in the code that CodeSpeak generated, or want to change a non-functional aspect of the code that's too low-level for the spec, you can create a Code Change Request (see docs) using the links below:

• Create a change request

This link creates a new file named change-request.cs.md. Describe the change you want to make and commit the file. CodeSpeak will pick it up, run the build and commit the changes back to the repo.