Skip to content

INDEX.md

Latest commit

 

History

History
210 lines (153 loc) · 5.02 KB

INDEX.md

File metadata and controls

210 lines (153 loc) · 5.02 KB
Raw

Construct CLI Documentation

Complete documentation for The Construct CLI.

Quick Links

Getting Started

  1. Install Construct

    • Platform-specific instructions
    • Container runtime setup
    • Post-installation verification

  2. Configure Construct

    • Runtime settings
    • Network modes
    • Security options
    • Provider configuration

  3. Learn Security Features

    • Container isolation
    • Secret redaction (experimental)
    • Security best practices

Core Features

Secret Redaction (Experimental)

Hide Secrets Mode - Complete guide

Prevents LLM agents from accessing raw secrets in your project:

  • File redaction (.env, config files, credentials)
  • Environment variable masking
  • Isolated workspace (OverlayFS/APFS)
  • Stream-time output masking

Provider Configuration

Providers Guide - Configure custom Claude endpoints

Supported providers:

  • Zai GLM
  • MiniMax M2
  • Kimi K2
  • Qwen
  • Mimo
  • And more...

Package Management

Packages Guide - Customize your sandbox

Install additional packages:

  • apt (Debian/Ubuntu)
  • brew (Homebrew)
  • bun (Bun package manager)
  • npm (Node.js)
  • pip (Python)

Reference Documentation

Architecture & Design

Architecture Design - Technical internals

  • System architecture
  • Component interactions
  • Security model
  • Performance considerations
  • Extension points

Clipboard Support

Clipboard Bridge - Clipboard integration

  • Text and image paste support
  • Per-agent compatibility
  • Platform-specific behavior
  • Troubleshooting

Development

Development Guide - Contributing to Construct

  • Build from source
  • Run tests
  • Code organization
  • Pull request process

Contributing Guidelines - Contribution standards

  • Code style guidelines
  • Commit message conventions
  • Issue reporting
  • Feature requests

Security Documentation

Container Security

Security Guide - Complete security reference

Topics covered:

  • Container isolation
  • User permissions
  • Filesystem boundaries
  • Network isolation
  • Build integrity

Secret Redaction

Hide Secrets Mode - User guide for experimental feature

  • Quick start guide
  • Configuration options
  • Use cases and examples
  • Troubleshooting
  • Limitations and future enhancements

Advanced Topics

Configuration

Configuration Guide - Complete reference

All settings explained:

  • Runtime configuration
  • Sandbox options
  • Network isolation
  • Security settings
  • Agent configuration
  • Daemon settings
  • Provider setup
  • Package management

Installation

Installation Guide - Detailed installation instructions

  • macOS (native runtime, Docker Desktop, OrbStack)
  • Linux (Podman, Docker)
  • Windows (WSL2)
  • Troubleshooting
  • Uninstallation

Documentation Index

Document Description
README Project overview, highlights, quick start
Installation Platform-specific installation guide
Configuration Complete configuration reference
Security Security features and best practices
Hide Secrets Secret redaction user guide
Providers Custom Claude API endpoints
Packages User-defined package management
Architecture Technical design and internals
Clipboard Clipboard integration details
Development Contributing and development
Contributing Contribution guidelines

Getting Help

CLI Help

construct --help              # Show all commands
construct sys doctor           # System health check
construct sys config           # Edit configuration
construct sys exec -- <cmd>    # Run command inside container

Documentation

Quick Reference

Installation:

curl -fsSL https://raw.githubusercontent.com/EstebanForge/construct-cli/main/scripts/install.sh | bash

First run:

construct sys init

Run agent:

construct claude "Help me with this code"

Configuration:

construct sys config  # Opens config in editor

← Back to README