/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
CLI CLI Reference stx projects

stx projects

Create, list, and delete Syntext projects from the command line.

1 min read

Manage Syntext projects without leaving your terminal. All subcommands require authentication — run stx login first.

Usage

bash
stx projects <subcommand> [options]

Subcommands

SubcommandDescription
create <name>Create a new project
listList your projects
delete <projectId>Delete a project (irreversible)

stx projects create

bash
stx projects create "Acme Docs"
text
✔ Project created!
ID: 3f2b8c1e-6a4d-4e2b-9c7f-1a2b3c4d5e6f
Name: Acme Docs
Slug: acme-docs
Docs URL: https://acme-docs-docs.syntext.dev
Connect this project to your local docs:
stx connect 3f2b8c1e-6a4d-4e2b-9c7f-1a2b3c4d5e6f
FlagDescription
--jsonOutput result as JSON
Note

Project creation is subject to your plan's limits. If you hit a limit, upgrade at app.syntext.dev/billing.

stx projects list

bash
stx projects list
text
✔ 2 projects
Acme Docs (pro)
ID: 3f2b8c1e-6a4d-4e2b-9c7f-1a2b3c4d5e6f
URL: https://acme-docs-docs.syntext.dev
Internal Wiki (free)
ID: 8d4e2a17-0c3b-4f59-a6e1-2b7c9d0e4f13
URL: https://wiki-docs.syntext.dev
FlagDescription
--jsonOutput projects as JSON

stx projects delete

bash
stx projects delete 3f2b8c1e-6a4d-4e2b-9c7f-1a2b3c4d5e6f --confirm
FlagDescription
--confirmRequired — acknowledges the action is irreversible
--jsonOutput result as JSON

Deleting a project needs the admin or owner role in its organization. Without --confirm, the command stops with This action is irreversible. Pass --confirm to proceed.

Warning

A deleted project can't be restored, and its slug can't be reused by a new project.

•
stx connect — link local docs to a project
•
stx login — authenticate the CLI
Was this page helpful? Yes No
Previous
Product
Resources
Company
© 2026 SyntextBuilt with Syntext