Skip to content

Quick Start

1) Install

sh
dotnet tool install -g coders

Installation/Usage Details

Initialize workspace

Run coders init to generate the default configuration and a sample .jssp file bundle.

  • Without -f|--force, it stops if config.yml exists.
  • -v|--verbose expands console logs to the info level.
  • --force overwrites existing files with the new template.

The default config.yml values are:

yaml
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 to config.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.

  • platform must match a platform key declared in projects in config.yml.
  • If config.yml is 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.

  • target is the extraction target (e.g. prompt), and platform is the platform key.
  • You can change the output directory with --output; if omitted, the current location is used.

Typical flow

sh
coders init
coders platform add <platform>
coders build <platform> -v

After initialization, add the required platform to the config, then run the build with the same key.

2) Initialize workspace

sh
coders init

Generated base files:

  • config.yml
  • main.jssp

3) Add platforms

sh
coders platform add springboot
coders platform add reactjs
coders platform add mysql

projects entries are added to config.yml.

4) Write DSL

Write Coders DSL in main.jssp.

js
domain Email string(320);

table user {
  user_id int64 auto;
  email Email unique;
  key(user_id);
}

5) Build

sh
coders build springboot

Outputs are generated in the outPath of config.yml.

Platform-specific build examples

sh
coders build springboot
coders build reactjs
coders build mysql

Each 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.

sh
coders build springboot
coders build reactjs
coders build mysql

The current CLI has no multi-platform batch build option, so run them sequentially.

6) Prompt extraction (Optional)

sh
coders extract prompt springboot

Useful when checking platform-specific transformation rules.

Checklist

  • Is the platform registered in projects in config.yml?
  • Does the entry file exist?
  • Are the LLM settings (llmOptions) correct?

Common mistakes

  • Omitting the platform key when running coders build
  • entry differs from main.jssp and was not updated
  • LLM provider/model name does not match the actual service