Environment Setup Use Cases

Install Manual Setup

The developer sets up the development environment manually on their local machine.

Actors

• ACT_DEV (Developer)

Interfaces

• IF_CLI (Command Line Interface)

Flow

1. Developer ensures local environment meets specifications.
2. Developer manually installs required tools.

---

Install via Binary Script

The developer installs the docgraph CLI binary using automated scripts.

Actors

• ACT_DEV (Developer)

Interfaces

• IF_GITHUB_RELEASES (GitHub Releases Interface)

Flow

1. Developer runs the platform-specific install script.
2. Script downloads the latest binary from GitHub Releases.

---

Install Claude Plugin

The developer installs the Docgraph plugin in Claude Desktop.

Actors

• ACT_DEV (Developer)

Interfaces

• IF_CLAUDE_MARKETPLACE (Claude Marketplace)

Flow

1. Developer adds the marketplace to Claude.
2. Developer installs the Docgraph plugin.

---

Install VS Code Extension

The developer installs the docgraph VS Code extension.

Actors

• ACT_DEV (Developer)

Interfaces

• IF_VSCODE_MARKETPLACE (VS Code Marketplace)

Flow

1. Developer downloads the VSIX file.
2. Developer installs the extension in VS Code.

---

Install Zed Extension

The developer installs the docgraph Zed extension.

Actors

• ACT_DEV (Developer)

Interfaces

• IF_ZED_UI (Zed UI)

Requirements

• FR_INSTALL_EXT_ZED (Zed Editor Extension) Enables Docgraph assistance within the Zed editor

Flow

1. Developer builds the extension targetting wasm32-wasip1.
2. Developer installs the dev extension in Zed.

---

Set Up Development Hooks

The developer sets up automated pre-commit hooks to ensure code quality and consistency.

Actors

• ACT_DEV (Developer)

Interfaces

• IF_CLI (Command Line Interface)

Requirements

• FR_INSTALL_PREK (Pre-commit Hook Support) Ensures all contributions meet the project's coding standards automatically.

Flow

1. Developer installs the prek tool.
2. Developer runs prek install -f to activate the hooks.