docs
Noyap setup reference
Install communication rules for one agent, every supported agent, or a directory-scoped workflow. Noyap keeps output concise while preserving warnings, project rules, and natural language style.
agents
modes
presets
npx @ppwnr88/noyap init --interactive
npx @ppwnr88/noyap init --all
npx @ppwnr88/noyap init --detected
npx @ppwnr88/noyap agents
npx @ppwnr88/noyap init --agent codex
npx @ppwnr88/noyap init --agent opencode
npx @ppwnr88/noyap init --mode thai-dev
npx @ppwnr88/noyap doctor
npx @ppwnr88/noyap doctor --all --fixconfiguration
noyap.config.json defaults
{
"language": "auto",
"mode": "balanced",
"preserveWarnings": true,
"codeFirst": true,
"maxExplanationLines": 4,
"preserveMixedLanguage": true,
"thaiTechnicalTerms": "preserve",
"naturalThaiMode": true,
"rolePreset": "default"
}language
auto, en, th
auto follows the user's language
mode
minimal, balanced, senior, thai-dev, bilingual, hardcore, hardcore-th
Controls response density
rolePreset
default, backend, frontend, devops, sql, security, reviewer
Adds role-specific priorities
preserveWarnings
true, false
Keep important warnings visible
codeFirst
true, false
Put code or commands first when useful
maxExplanationLines
number
Soft limit for extra explanation
preserveMixedLanguage
true, false
Keep Thai/English developer style mixed
thaiTechnicalTerms
preserve, translate
Keep common dev terms in English by default
naturalThaiMode
true, false
Avoid formal translated Thai
agentsMdStrategy
merge, separate, overwrite, cancel
CLI-only AGENTS.md handling
options
Common workflows
Language options
Auto-detect English, Thai, and mixed Thai/English developer language.
AGENTS.md strategy
Use merge, separate, overwrite, or cancel for Codex and OpenCode projects.
Doctor command
Check generated files and config, or run --all --fix to repair missing files.
Diff and dry run
Preview generated changes with init --all --dry-run or diff --all.
Update and remove
Refresh existing Noyap files with update --all or remove generated rules with remove --all.
Shell completion
Generate completion scripts for zsh, bash, and fish.
Warning preservation
Keep security, data-loss, migration, deploy, and breaking-change warnings visible.
Full package docs live in the GitHub README.