/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
Components Command list

Command list

CommandList shows CLI commands with a one-line description each.

2 min read

<CommandList> draws CLI commands with a one-line description each, linking to their pages.

Note

Doc engine v2 only (presets). A v1 site doesn't draw <CommandList>: used empty it shows nothing, and any content inside it shows as plain text.

Used empty

mdx
<CommandList />

With no content, it lists the pages of a section named CLI.

Used empty, it fills itself from your site. Give it content of its own and it shows only that. With no content and nothing on the site to fill it, it draws nothing and the build log says so:

text
<CommandList>: the site has no CLI section, so it shows nothing. Give it content or remove it.

With your own content

A two-column table — command, then description:

mdx
<CommandList>
| Command | Description |
|---------|-------------|
| [`stx dev`](/cli/dev) | Preview locally |
| [`stx deploy`](/cli/deploy) | Publish your docs |
</CommandList>

Or a list of `command` — description lines. A command written as a link links to its page:

mdx
<CommandList>
- `stx init` — create a project
- [stx deploy](/cli/deploy) — publish your docs
</CommandList>

Props

PropTypeDefaultDescription
titlestring"quick links"Heading of the block, where the preset draws one
limitnumber6Most commands shown when it fills itself

In each preset

It's drawn in your preset's home style — or in the layout named by appearance.layout.home while that setting still works. Console draws its quick links. The other presets draw a table. On a page with the normal frame it sits in the content column; on a layout: wide page it runs across the page.

Example

This site's own, from <CommandList limit={4} />:

CommandDescription
CLI OverviewThe stx command-line interface for building, previewing, and deploying Syntext documentation.
stx initInitialize a new Syntext documentation project.
stx devDeploy a preview build and redeploy it as you edit.
stx buildBuild your documentation on Syntext's servers and download the static site for self-hosting.
•
Hero and Search — the hero and the home search box
Was this page helpful? Yes No
Previous
Product
Resources
Company
© 2026 SyntextBuilt with Syntext