Quick Start
1) Install
dotnet tool install -g codersInstallation/Usage Details
Initialize workspace
Run coders init to generate the default configuration and a sample .jssp file bundle.
- Without
-f|--force, it stops ifconfig.ymlexists. -v|--verboseexpands console logs to the info level.--forceoverwrites existing files with the new template.
The default config.yml values are:
llmOptions:
# LLM provider to use
provider: "ollama"
# Model name used for build
model: "gpt-oss-safeguard:20b"
# LLM endpoint and credentials
url: "http://localhost:11434"
apiKey: "OLLAMA_API_KEY"
timeoutSeconds: 300
stream: true
entry: main.jssp
projects: []The root llmOptions handles provider, model, endpoint, auth, timeout, and streaming settings needed for LLM calls. projects defines platform outputs; add items via coders platform add and then edit them.
Platform management
coders platform list [-v]: prints registered platform keys and default target/language info.coders platform add <platform> [-v]: adds the default project config for the specified platform toconfig.yml. Edit the generated entry/output path and options as needed.coders platform remove <platform> [-v]: reserved subcommand.
Source build
coders build <platform> [-v] parses .jssp and generates code for the specified platform.
platformmust match a platform key declared inprojectsinconfig.yml.- If
config.ymlis missing, the build stops; if the entry file is missing, it errors. - The output directory is created automatically if it does not exist.
Prompt extraction
coders extract <target> <platform> [-o|--output <path>] [-v] extracts prompts and other resources.
targetis the extraction target (e.g.prompt), andplatformis the platform key.- You can change the output directory with
--output; if omitted, the current location is used.
Typical flow
coders init
coders platform add <platform>
coders build <platform> -vAfter initialization, add the required platform to the config, then run the build with the same key.
2) Initialize workspace
coders initGenerated base files:
config.ymlmain.jssp
3) Add platforms
coders platform add springboot
coders platform add reactjs
coders platform add mysqlprojects entries are added to config.yml.
4) Write DSL
Write Coders DSL in main.jssp.
domain Email string(320);
table user {
user_id int64 auto;
email Email unique;
key(user_id);
}5) Build
coders build springbootOutputs are generated in the outPath of config.yml.
Platform-specific build examples
coders build springboot
coders build reactjs
coders build mysqlEach platform is generated into a separate output directory based on the projects settings.
Build multiple platforms with a single run
Repeat platform keys or bundle them in a script.
coders build springboot
coders build reactjs
coders build mysqlThe current CLI has no multi-platform batch build option, so run them sequentially.
6) Prompt extraction (Optional)
coders extract prompt springbootUseful when checking platform-specific transformation rules.
Checklist
- Is the platform registered in
projectsinconfig.yml? - Does the
entryfile exist? - Are the LLM settings (
llmOptions) correct?
Common mistakes
- Omitting the platform key when running
coders build entrydiffers frommain.jsspand was not updated- LLM provider/model name does not match the actual service