Archbee CLI Command Examples

archbee cli command examples this guide shows common archbee cli workflows with practical command examples most local development commands can run without authentication commands that interact with content on the archbee platform usually require both an api key and a space id local development use these commands while writing or testing documentation locally preview your docs with live reload during development archbee dev example output archbee local server running at http //localhost 3000 watching files for changes the local site typically runs on http //localhost 3000 validate your documentation structure and configuration archbee validate example output ✓ configuration valid ✓ no structural issues found this command helps detect missing config files, invalid structures, and other common setup issues check for broken internal links archbee broken links example output scanning documentation ✓ no broken links found this is useful before publishing changes managing documents most document management commands require \ api key doc space id search for documents inside a documentation space archbee search docs api key your api key doc space id space id example output found 12 matching documents retrieve a document by id archbee get doc doc id format markdown api key your api key doc space id space id example output document exported successfully the format flag supports formats such as markdown, html, json, and source create a new document or update an existing one from a local markdown file archbee create doc /doc md api key your api key doc space id space id example output document created successfully delete a document from a space archbee delete doc doc id api key your api key doc space id space id example output document deleted successfully use delete commands carefully because they directly affect published documentation openapi workflows the archbee cli can import and synchronize openapi specifications to generate api reference documentation sync an openapi file into a documentation space archbee sync openapi openapi yaml api key your api key doc space id space id example output openapi sync completed successfully retrieve information about an existing openapi documentation tree archbee info openapi tree id api key your api key doc space id space id example output openapi tree contains 24 endpoints if synchronization fails, validate the openapi schema before retrying file manager commands the cli can also manage uploaded files directly from the terminal upload a file archbee upload /logo png api key your api key example output file uploaded successfully list uploaded files and folders archbee list files api key your api key example output found 42 files replace an existing file while keeping the same public url archbee replace file file id /new logo png api key your api key example output file replaced successfully the replace file command updates a file while preserving the same public url, which helps avoid broken links in documentation publishing changes publish documentation updates to production archbee publish space api key your api key doc space id space id example output space published successfully make sure the api key has write permissions before publishing getting command help every cli command supports the help flag archbee \<command> help example archbee create doc help example output usage archbee create doc \[options] this displays all supported flags, arguments, and usage examples for the selected command additional resources https //archbee com/docs https //archbee com/docs https //www npmjs com/package/@archbee/cli https //www npmjs com/package/@archbee/cli