Before you continue...

CARLOS is an AI-enabled project, and all CARLOS software to date has been entirely produced using a combination of LLM-based coding products from Anthropic, OpenAI, and open-weight alternatives. Whilst CARLOS represents an approach to apply these products toward new standards of openness and release of corporate ownership of internet-based software and data, we realise that there are folks for whom use of these products is unacceptable. With that said, if folks will continue to use AI to produce software, our mission is to show that AI unlocks ways to produce better software for everyone.

One of the principles behind the project is full disclosure of AI use, and AI-written language, starting here.

Get started

Build with your agent, or deploy a sample app yourself.

Copy this prompt into your coding agent

Build [describe your app] using CARLOS principles and Rastrillo.

Read https://github.com/carlosframework/skills/blob/main/skills/getting-started/SKILL.md and https://rastrillo.org/SKILL.md first.

I want to deploy to carloku.com. Help me connect my account, then build, test and deploy the app. Use the current installation commands in rastrillo.org/SKILL.md.

You need Git, Go 1.26 or later, and the CARLOS command-line tool.

brew install carlosframework/tap/carlos
Other installation options

Download and test the Notes example

git clone --depth 1 https://amadan.net/rastrillo/rastrillo
cd rastrillo/examples/notes
go test ./...
GOOS=linux GOARCH=arm64 CGO_ENABLED=0 go build -o notes-linux-arm64 ./cmd/notes

Connect your account and create the app

carlos auth login --console https://console.carloku.com
carlos auth whoami
carlos apps create --app notes

Approve the sign-in code in your browser. Replace YOUR_ACCOUNT_ID below with the account short ID printed by whoami.

Create an instance and deploy it

carlos instances enable --app notes
carlos instances create --app notes --host notes.YOUR_ACCOUNT_ID.oncarlos.com --channel edge
carlos env set --app notes NOTES_ORIGIN=https://notes.YOUR_ACCOUNT_ID.oncarlos.com
carlos deploy --app notes ./notes-linux-arm64

The deploy command prints the live URL. Open it in your browser.

CARLOS CLI guide