npx skills add ...
npx skills add encoredev/skills --skill encore-getting-started
npx skills add encoredev/skills --skill encore-getting-started
Bootstrap a brand-new Encore.ts project from zero. Only for first-time CLI install and `encore app create` — not for architecture or feature questions.
A minimal Encore.ts app:
This file marks the root of your Encore app. The id is your app's unique identifier.
Create encore.service.ts to define a service:
The dashboard shows:
| Command | Description |
|---|---|
encore run | Start the local development server |
encore test | Run tests |
encore db shell <db> | Open a psql shell to a database |
encore gen client | Generate API client code |
encore app link | Link to an existing Encore Cloud app |
Create a migration:
encore-api skill)encore-auth skill)encore-pubsub), cron jobs (encore-cron), buckets (encore-bucket), secrets (encore-secret), or caching (encore-cache)encore app link then git push encoremy-app/
├── encore.app # App configuration
├── package.json # Dependencies
├── tsconfig.json # TypeScript config
├── encore.service.ts # Service definition
└── api.ts # API endpoints// encore.app
{
"id": "my-app"
}// encore.service.ts
import { Service } from "encore.dev/service";
export default new Service("my-service");// api.ts
import { api } from "encore.dev/api";
interface HelloResponse {
message: string;
}
export const hello = api(
{ method: "GET", path: "/hello", expose: true },
async (): Promise<HelloResponse> => {
return { message: "Hello, World!" };
}
);# Start the development server
encore run
# Your API is now available at http://localhost:4000# Opens the local development dashboard
encore run
# Then visit http://localhost:9400// db.ts
import { SQLDatabase } from "encore.dev/storage/sqldb";
const db = new SQLDatabase("mydb", {
migrations: "./migrations",
});-- migrations/1_create_table.up.sql
CREATE TABLE items (
id SERIAL PRIMARY KEY,
name TEXT NOT NULL
);