Specs

Ask CloudForge to write a spec for a component before it builds it.

On this page

Create a spec

  1. On the architecture canvas, right-click a part.
  2. Choose Create Spec….
  3. CloudForge looks through your code and writes the spec.

The spec is saved as a Markdown file in .cloudforge/specs/, named with the part's ID. It is a normal file. Read it and edit it like any other.

What a spec holds

  • The scope: what this part does and does not do.
  • The interfaces it offers to other parts.
  • The files to create or change.
  • Acceptance criteria: how you know it works.

Build from the spec

When you choose Implement Component on a part that has a spec, CloudForge follows the spec. See Implement a component.

Keyboard shortcuts

Docs keyboard shortcuts
Ctrl + KOpen search
/Open search
?Show this list
[Previous page
]Next page
EscClose search, this list or the menu

Turn these off if they get in the way of speech input or other tools. Ctrl + K always works.