​
Documentation Structure

Our documentation is organized into several key sections:

​
Get Started

Quick Start Example

Get started quickly with our example repository and see cuse in action within minutes.

Add to Existing Project

Learn how to integrate cuse into your existing development workflow and projects.

​
Core Concepts

Learn about the fundamental concepts of cuse:

  • Computer - Understanding the core computing environment
  • App - Working with applications in cuse

​
CLI Reference

Learn how to use the cuse CLI and get started with the following commands:

  • init - Initialize cuse in an existing project
  • new - Create a new computer
  • start - Start computers in the current project or a specific computer by identifier
  • stop - Stop all running computers and the proxy server for the current project
  • status - Display the status of running cuse computers
  • list - List all cuse computers (running and stopped)
  • rm - Remove a specific cuse computer
  • destroy - Remove all project computers

​
API Reference

Learn how to use the cuse API to interact with your computer:

  • computer - Interact with the computer display, mouse, and keyboard
  • editor - A tool for editing files on the computer
  • bash - Interact with the shell of the computer

​
Getting Help

Need assistance? Join our community:

Quickstart