CAVE CLI

A cross-platform CLI for creating and managing Docker-based CAVE web applications.

Developed by MIT-CAVE (Center for Transportation & Logistics). Licensed under Apache 2.0.

Prerequisites

• Python 3.11+
• Docker 23.0.6+
• Git

# Install Docker
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh ./get-docker.sh
# Add the current user to the docker group
dockerd-rootless-setuptool.sh install
# Make sure it works outside of sudo
docker run hello-world

Installation

Install with uv (required to run cave update and cave uninstall):

uv tool install cave_cli

If you don't have uv, install it first:

# With Homebrew (recommended)
brew install uv

# Or with the official installer
curl -LsSf https://astral.sh/uv/install.sh | sh

curl -LsSf https://astral.sh/uv/install.sh | sh

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

For more options see the uv installation guide.

Verify the installation and check your environment health:

cave doctor

Quick Start

cave create my_app
cd my_app
cave run
# Open http://localhost:8000/ in your browser

CLI Commands

cave --help

Core Commands

Peripheral Commands

Utility Commands

Global Flags

cave run Options

Updating

cave update

Or directly via uv:

uv tool upgrade cave_cli

License Notice

Copyright 2023 Massachusetts Institute of Technology (MIT), Center for Transportation & Logistics (CTL)

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.