biticaret developer docs
Build themes and apps for biticaret stores with the biticaret CLI, Liquid and the App API. For people and for AI coding agents.
Quick start
With the CLI on your PATH (Install the CLI), sign in and create a starter theme and app:
Every command and flag is documented on the CLI page.
Build a theme
-
Start from the skeleton theme, biticaret/skeleton-theme:
biticaret theme init my-theme cd my-theme -
Edit the templates, sections and blocks. Theme structure explains how a theme is organised.
-
Run the upload checks:
biticaret theme check --strict . -
Zip the theme folders and upload the archive in your development store's admin under Online Mağaza > Temalar (Online store > Themes).
Full walkthrough: Build a theme.
Build an app
-
Start from the Go template, biticaret/app-template-go. Pass
--templateto start from an example app instead: theme-blocks, functions or ui-extensions.
biticaret app init my-app cd my-app -
Check the configuration. This works offline:
biticaret app check -
Sign in and create the app in your organisation:
biticaret auth login biticaret app config link -
Upload a version and release it:
biticaret app deploy --submit
Full walkthrough, including server setup and installation: Build an app.
Popular references
- Theme objectsThe objects a theme template can use, and their fields.
- Theme filtersThe Liquid filters a theme template can use, grouped by what they work on.
- App API routesEvery route under /oauth and /api/v1: its HTTP method, required scope and pagination support.
- Webhook topicsThe webhook topics an app can subscribe to, the scope each requires, and the mandatory KVKK privacy topics.
- biticaret.app.toml keysEvery key in biticaret.app.toml, its type and its description.
For AI agents
Every page is also available as Markdown at the same URL with a .md extension. llms.txt lists every page, and llms-full.txt combines all of them into one file. The AGENTS.md files in the starter projects point coding agents here. biticaret mcp serves these same docs, schemas and checks as an MCP server: see Work with an AI coding agent.