README
¶
Run the examples
The canonical example catalog orders every command by prerequisite, learning goal, controls, and public API. Its Chinese translation follows the same executable path.
Run one command from the repository root:
go run ./examples/hello
Test the complete example module with:
cd examples
go test ./...
Every command has a neighboring main_test.go. The catalog test derives command names from these directories and rejects missing or duplicated documentation entries.
Directories
¶
| Path | Synopsis |
|---|---|
|
Command agent is a complete mock coding-agent session.
|
Command agent is a complete mock coding-agent session. |
|
Command composer demonstrates a product-grade prompt without inventing a prompt framework: completion, history and atomic paste chips are ordinary editor behavior composed with application policy.
|
Command composer demonstrates a product-grade prompt without inventing a prompt framework: completion, history and atomic paste chips are ordinary editor behavior composed with application policy. |
|
Command content composes Markdown, syntax highlighting, and LaTeX.
|
Command content composes Markdown, syntax highlighting, and LaTeX. |
|
Command dashboard is more panes than fit, with one of them showing.
|
Command dashboard is more panes than fit, with one of them showing. |
|
Command files browses a directory beside what is in it.
|
Command files browses a directory beside what is in it. |
|
Command form asks four questions, on a screen or in words.
|
Command form asks four questions, on a screen or in words. |
|
Command hello is the smallest complete Oolong program.
|
Command hello is the smallest complete Oolong program. |
|
internal
|
|
|
latexlook
Package latexlook maps the example theme onto mathematical LaTeX.
|
Package latexlook maps the example theme onto mathematical LaTeX. |
|
markdownlook
Package markdownlook maps the example theme onto Markdown.
|
Package markdownlook maps the example theme onto Markdown. |
|
visualtest
Package visualtest captures the screen produced by an example program.
|
Package visualtest captures the screen produced by an example program. |
|
Command keys demonstrates an exact binding that is also the prefix of a longer one.
|
Command keys demonstrates an exact binding that is also the prefix of a longer one. |
|
Command latex renders mathematical LaTeX without Markdown.
|
Command latex renders mathematical LaTeX without Markdown. |
|
Command markdown renders a finished Markdown document.
|
Command markdown renders a finished Markdown document. |
|
Command picker narrows a list as you type.
|
Command picker narrows a list as you type. |
|
Command read shows an answer as it is written.
|
Command read shows an answer as it is written. |
|
Command run runs something and shows what it said, in colour.
|
Command run runs something and shows what it said, in colour. |
|
Command state shows the four outcomes of one headless text-field API: local state, an exact caller binding, normalization, and rejection.
|
Command state shows the four outcomes of one headless text-field API: local state, an exact caller binding, normalization, and rejection. |
|
Command streaming is Oolong's canonical streaming interface.
|
Command streaming is Oolong's canonical streaming interface. |
Click to show internal directories.
Click to hide internal directories.