-
Notifications
You must be signed in to change notification settings - Fork 0
Configuration Guide
github-actions[bot] edited this page Jun 29, 2026
·
1 revision
Complete reference for kyto.toml and .kyto.config.
kyto.toml → WHERE outputs go (paths, toggles)
.kyto.config → WHAT the values are (domain, users, env)
kyto/*.kyto → HOW to transform (optional code)
| Key | Default | Description |
|---|---|---|
name |
my-project |
Project label |
entry |
kyto/main.kyto |
Main .kyto source |
config_only |
false |
true = skip .kyto, compile from config only |
Recommended for new projects:
[project]
name = "my-app"
config_only = true| Key | Default | Description |
|---|---|---|
file |
.kyto.config |
Path to simple config overlay |
| Key | Default | Description |
|---|---|---|
enabled |
true |
Write env files |
file |
.env |
Output env file |
example |
.env.example |
Redacted example for git |
redact_keys |
SECRET, TOKEN, … |
Substrings that trigger redaction in .env.example
|
| Key | Default | Description |
|---|---|---|
enabled |
true |
Write user artifacts |
sql |
generated/users.sql |
SQL seed path |
sql_table |
users |
INSERT target table |
typescript |
src/generated/users.ts |
TS output (null to skip) |
typescript_export |
AUTHORIZED_USERS |
Exported const name |
json |
generated/users.json |
JSON name list |
| Key | Default | Description |
|---|---|---|
enabled |
true |
Write deploy shell snippet |
script |
scripts/generated/deploy-env.sh |
Output bash file |
| Key | Description |
|---|---|
enabled |
Append apply_user_roles() SQL hook |
command |
Shell prefix before heredoc |
admin_role |
Role string for admins |
user_role |
Role string for non-admins |
+ Comment to end of line
DOMAIN host.example.com
ADMIN alice
USERS alice bob carol
DATABASE_URL postgresql://user:pass@host/db
REPO_SSH git@github.com:org/repo.git
REPO_DIR /var/www/app
CUSTOM_KEY any value with spaces
QUOTED "value with spaces"
| Line pattern | Compiler behavior |
|---|---|
DOMAIN host |
Sets APP_URL=https://host
|
USERS a b c |
Login names (lowercased) |
ADMIN a |
Admin subset of USERS
|
KEY value |
Arbitrary env variable |
REPO_* |
Deploy map (REPO_DIR → export in deploy script) |
+ ... |
Comment (ignored) |
API_KEY "sk-live-abc 123"
Quotes are stripped; inner spaces preserved.
[project]
name = "cloud-portal"
config_only = true
[config]
file = ".kyto.config"
[emit.env]
file = ".env"
example = ".env.example"
redact_keys = ["SECRET", "TOKEN", "PASSWORD", "KEY"]
[emit.users]
sql = "generated/seed.sql"
json = "generated/users.json"
typescript = "src/generated/users.ts"
typescript_export = "AUTHORIZED_USERS"
sql_table = "users"
[emit.deploy]
script = "generated/deploy-env.sh".env
.kyto.config
kyto/local.kyto
kyto/local.kyto.enc
generated/Safe to commit: kyto.toml, .kyto.config.example, .env.example, generated/*.example
- run: kura check
- run: kura compile
- run: git diff --exit-code generated/Fails CI if someone forgot to recompile after config changes.