Where to Find Documentation for denoland/celld: A Complete Guide

Documentation for denoland/celld lives in the repository's root README.md and the dedicated docs/ directory, covering installation, CLI usage, Rust library API, consistency guarantees, and operational guides.

All user‑facing documentation for the celld project is maintained inside the repository itself. The project follows a docs‑as‑code approach, with Markdown files organized for both quick‑start users and deep‑dive implementers. This guide maps where to find official celld documentation and how to use each resource effectively.

Primary Documentation Locations

Root README: High‑Level Overview and Installation

The first stop for any celld user is README.md at the repository root [source]. This file contains:

• Project overview and architecture summary
• One‑line installer command
• Essential CLI commands for development and deployment
• Quick links to deeper documentation

# Install the binary (official installer)

curl -fsSL https://celld.dev/install.sh | sh

# Run a local development node (no bucket required)

celld dev

# Deploy a Worker project to a bucket

celld deploy . --bucket s3://my-cells-bucket

# Diagnose a fleet (runs the conditional‑write storage test)

celld diagnose --bucket s3://my-cells-bucket

docs/ Directory: Structured Guides and Reference

The docs/ folder [source] contains the complete documentation suite. Start with docs/README.md for a topical index, then navigate to specific guides based on your use case.

Core Documentation Files

API Reference: docs/library-api.md

For developers integrating celld as a Rust dependency, docs/library-api.md [source] documents the crate's public surface, including how to work with durability owners for managing distributed state.

use celld::asyncrt::select;
use celld::node_log::{DurabilityOwner, start_background};

async fn run_example() {
    // Create a durability owner after node‑log recovery
    let owner = DurabilityOwner::new().await;
    owner.start_background().await;

    // Example select! macro usage
    select! {
        "first" => println!("first branch wins"),
        "second" => println!("second branch wins"),
    }
}

Key types covered in this file include DurabilityOwner for recovery and select! for async coordination.

Consistency Guarantees: docs/guarantees.md

Understanding celld's distributed behavior requires docs/guarantees.md [source]. This file explains:

• Fencing mechanisms for split‑brain prevention
• The durability model and write acknowledgment semantics
• Consistency boundaries under failure scenarios

Testing Strategy: docs/testing.md

Operators running production deployments should review docs/testing.md [source], which covers:

• How the test suite validates the storage layer
• Self‑fencing behavior verification
• The celld diagnose command for fleet health checks

Operational Documentation

Platform and Security Guides

File	Purpose
docs/limitations.md [source]	Known limitations and unsupported deployment scenarios
docs/security.md [source]	Security model and bucket credential handling best practices
docs/telemetry.md [source]	Metrics emission and observability configuration
docs/cloudflare-compat.md [source]	Compatibility considerations for Cloudflare Workers

How to Browse celld Documentation

Denoland/celld documentation can be accessed in three ways:

1. GitHub web interface — navigate directly to file URLs for inline Markdown rendering
2. Local clone — run git clone https://github.com/denoland/celld.git and open files in any Markdown viewer or IDE
3. Raw file access — append ?raw=1 to GitHub URLs for plain Markdown source

Summary

• Root README.md provides installation, quick‑start CLI commands, and project overview
• docs/ directory contains the complete documentation suite with topical organization
• docs/library-api.md is the primary reference for Rust crate integration and DurabilityOwner usage
• docs/guarantees.md explains fencing, durability semantics, and consistency models
• Operational guides cover testing, limitations, security, telemetry, and platform compatibility
• All documentation is Markdown‑based and browsable on GitHub or locally after cloning

Frequently Asked Questions

Is there an official website for celld documentation?

No dedicated documentation site exists. According to the denoland/celld source code, all official documentation resides in the GitHub repository under README.md and the docs/ directory. The install script at https://celld.dev/install.sh is the only external resource referenced.

How do I find the Rust API reference for celld?

The Rust API is documented in docs/library-api.md [source]. This file covers the DurabilityOwner type for managing durable state and the select! macro for async operations. The project does not currently publish docs to docs.rs.

What documentation covers celld's consistency and durability guarantees?

docs/guarantees.md [source] provides the authoritative explanation of fencing, write durability, and failure behavior. This document is essential for architects evaluating celld for production workloads.

How can I validate my celld deployment is working correctly?

Run celld diagnose --bucket s3://your-bucket to execute the conditional‑write storage test, and consult docs/testing.md [source] for the complete testing strategy including self‑fencing validation.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}