Holodeck

A tool for creating and managing GPU-ready Cloud test environments.

---

📖 Documentation

• Quick Start
• Prerequisites
• Commands Reference
• Contributing Guide
• Examples
• Latest Release

---

🚀 Quick Start

See docs/quick-start.md for a full walkthrough.

make build
sudo mv ./bin/holodeck /usr/local/bin/holodeck
holodeck --help

---

🛠️ Prerequisites

• Go 1.20+
• (For AWS) Valid AWS credentials in your environment
• (For SSH) Reachable host and valid SSH key

See docs/prerequisites.md for details.

---

📝 How to Contribute

See docs/contributing/ for full details.

Main Makefile Targets

• make build – Build the holodeck binary
• make test – Run all tests
• make lint – Run linters
• make clean – Remove build artifacts

---

🧑‍💻 Usage

See docs/commands/ for detailed command documentation and examples.

holodeck --help

Example: Create an environment

holodeck create -f ./examples/v1alpha1_environment.yaml

Example: List environments

holodeck list

Example: Delete an environment

holodeck delete <instance-id>

Example: Check status

holodeck status <instance-id>

Example: Dry Run

holodeck dryrun -f ./examples/v1alpha1_environment.yaml

📂 More

• Examples
• Guides

---

For more information, see the documentation directory.