# Caido

> A lightweight web security auditing toolkit

Developer Documentation

## Table of Contents

### Getting Started

- [Getting Started](/plugins/guides.md)
- [Configure Package](/plugins/guides/config.md)
- [AI Assisted Coding](/plugins/guides/vibe_coding.md)
- [Set Up Repository](/plugins/guides/repository.md)
- [Submit to Store](/plugins/guides/store.md)
- [Contributing](/plugins/guides/documentation.md)

### Frontend Guides

#### User Interface

- [Create a Page](/plugins/guides/page.md)
- [Create a Command](/plugins/guides/command.md)
- [Customize Context Menus](/plugins/guides/menu.md)
- [Use the Component Library](/plugins/guides/styling.md)
- [Extend Editors](/plugins/guides/editor_extensions.md)
- [Add View Modes](/plugins/guides/view_modes.md)
- [Add to UI Slots](/plugins/guides/slots.md)
- [Show Dialogs](/plugins/guides/dialogs.md)
- [Register Shortcuts](/plugins/guides/shortcuts.md)
- [Customize Command Palette](/plugins/guides/command_palette_advanced.md)
- [Custom Settings Pages](/plugins/guides/settings.md)

#### Data Storage

- [Store Frontend Data](/plugins/guides/frontend_storage.md)
- [Access Static Assets](/plugins/guides/assets.md)

#### Caido Features

- [Use HTTPQL Queries](/plugins/guides/filters.md)
- [Manage Scopes](/plugins/guides/scopes.md)
- [Manage Replay Sessions](/plugins/guides/replay.md)
- [Manage Automate Sessions and Entries](/plugins/guides/automate.md)
- [Manage Sitemap](/plugins/guides/sitemap.md)
- [Manage Match and Replace](/plugins/guides/match_replace.md)
- [Interact with Workflows](/plugins/guides/workflows.md)

#### Events

- [Subscribe to Application Events](/plugins/guides/application_events.md)
- [Listen to Navigation Events](/plugins/guides/navigation_events.md)

#### System Integration

- [Log Messages](/plugins/guides/log.md)
- [Get Version Information](/plugins/guides/runtime.md)

#### Advanced Features

- [Use AI in Your Plugin](/plugins/guides/ai.md)

### Backend Guides

#### Working with HTTP

- [Send HTTP Requests](/plugins/guides/request.md)
- [Send a Fetch Request](/plugins/guides/fetch.md)
- [Fetch Proxied Requests](/plugins/guides/querying_requests.md)
- [Use Invalid UTF-8](/plugins/guides/utf.md)

#### Caido Features

- [Use Findings](/plugins/guides/findings.md)
- [Use Environment Variables](/plugins/guides/env.md)

#### Data Storage

- [Store Data in SQLite](/plugins/guides/sqlite.md)
- [Add Files](/plugins/guides/files.md)

#### Events

- [Handle Backend Events](/plugins/guides/backend_events.md)
- [Call Custom Functions](/plugins/guides/rpc.md)
- [Send Events to the Frontend](/plugins/guides/events.md)
- [Intercept Requests and Connections](/plugins/guides/plugin_upstream.md)

#### System Integration

- [Spawn a Process](/plugins/guides/spawning_process.md)

### Tutorials

- [Tutorials](/plugins/tutorials.md)

### Example Plugins

- [Notebook](/plugins/tutorials/notebook.md)

### Reference

- [Reference](/plugins/reference.md)

### SDKs

#### Backend

- [@caido/sdk-backend](/plugins/reference/sdks/backend.md)
- [API](/plugins/reference/sdks/backend/api.md)
- [Environment](/plugins/reference/sdks/backend/environment.md)
- [Events](/plugins/reference/sdks/backend/events.md)
- [Findings](/plugins/reference/sdks/backend/findings.md)
- [GraphQL](/plugins/reference/sdks/backend/graphql.md)
- [HostedFile](/plugins/reference/sdks/backend/hostedfile.md)
- [Meta](/plugins/reference/sdks/backend/meta.md)
- [Other](/plugins/reference/sdks/backend/other.md)
- [Projects](/plugins/reference/sdks/backend/projects.md)
- [Replay](/plugins/reference/sdks/backend/replay.md)
- [Requests](/plugins/reference/sdks/backend/requests.md)
- [Runtime](/plugins/reference/sdks/backend/runtime.md)
- [Scope](/plugins/reference/sdks/backend/scope.md)
- [Shared](/plugins/reference/sdks/backend/shared.md)

#### Frontend

- [@caido/sdk-frontend](/plugins/reference/sdks/frontend.md)
- [AI](/plugins/reference/sdks/frontend/ai.md)
- [Automate](/plugins/reference/sdks/frontend/automate.md)
- [Backend](/plugins/reference/sdks/frontend/backend.md)
- [Command Palette](/plugins/reference/sdks/frontend/command-palette.md)
- [Commands](/plugins/reference/sdks/frontend/commands.md)
- [Editor](/plugins/reference/sdks/frontend/editor.md)
- [Environment](/plugins/reference/sdks/frontend/environment.md)
- [Files](/plugins/reference/sdks/frontend/files.md)
- [Filter](/plugins/reference/sdks/frontend/filter.md)
- [Filters](/plugins/reference/sdks/frontend/filters.md)
- [Findings](/plugins/reference/sdks/frontend/findings.md)
- [Footer](/plugins/reference/sdks/frontend/footer.md)
- [HTTP History](/plugins/reference/sdks/frontend/http-history.md)
- [Intercept](/plugins/reference/sdks/frontend/intercept.md)
- [JSON](/plugins/reference/sdks/frontend/json.md)
- [Log](/plugins/reference/sdks/frontend/log.md)
- [Match and Replace](/plugins/reference/sdks/frontend/match-and-replace.md)
- [Menu](/plugins/reference/sdks/frontend/menu.md)
- [Navigation](/plugins/reference/sdks/frontend/navigation.md)
- [Other](/plugins/reference/sdks/frontend/other.md)
- [Projects](/plugins/reference/sdks/frontend/projects.md)
- [Replay](/plugins/reference/sdks/frontend/replay.md)
- [Request](/plugins/reference/sdks/frontend/request.md)
- [Runtime](/plugins/reference/sdks/frontend/runtime.md)
- [Scopes](/plugins/reference/sdks/frontend/scopes.md)
- [Search](/plugins/reference/sdks/frontend/search.md)
- [Shortcuts](/plugins/reference/sdks/frontend/shortcuts.md)
- [Sidebar](/plugins/reference/sdks/frontend/sidebar.md)
- [Sitemap](/plugins/reference/sdks/frontend/sitemap.md)
- [Slots](/plugins/reference/sdks/frontend/slots.md)
- [Storage](/plugins/reference/sdks/frontend/storage.md)
- [UI](/plugins/reference/sdks/frontend/ui.md)
- [Utils](/plugins/reference/sdks/frontend/utils.md)
- [Window](/plugins/reference/sdks/frontend/window.md)
- [Workflows](/plugins/reference/sdks/frontend/workflows.md)

#### Workflow

- [@caido/sdk-workflow](/plugins/reference/sdks/workflow.md)
- [Data](/plugins/reference/sdks/workflow/data.md)
- [Environment](/plugins/reference/sdks/workflow/environment.md)
- [Findings](/plugins/reference/sdks/workflow/findings.md)
- [GraphQL](/plugins/reference/sdks/workflow/graphql.md)
- [HostedFile](/plugins/reference/sdks/workflow/hostedfile.md)
- [Other](/plugins/reference/sdks/workflow/other.md)
- [Projects](/plugins/reference/sdks/workflow/projects.md)
- [Replay](/plugins/reference/sdks/workflow/replay.md)
- [Requests](/plugins/reference/sdks/workflow/requests.md)
- [Runtime](/plugins/reference/sdks/workflow/runtime.md)
- [Scope](/plugins/reference/sdks/workflow/scope.md)
- [Shared](/plugins/reference/sdks/workflow/shared.md)

### Runtime

- [QuickJS Modules](/plugins/reference/modules.md)

### Files

- [caido.config.ts](/plugins/reference/config.md)
- [plugin\_packages.json](/plugins/reference/plugin_packages.md)
- [manifest.json](/plugins/reference/manifest.md)

### Concepts

- [Concepts](/plugins/concepts.md)

### Frontend

- [UI Styling](/plugins/concepts/ui.md)

### Backend

- [Dealing with Binary Data](/plugins/concepts/binary.md)
- [Backend Plugins vs Workflows](/plugins/concepts/workflow.md)

### Essentials

- [Plugin Architecture](/plugins/concepts/package.md)
- [Tooling for Plugin Development](/plugins/concepts/tooling.md)
- [Runtime](/plugins/concepts/runtime.md)
- [Plugin Signing](/plugins/concepts/signing.md)

### Modules

- [Child Process](/plugins/concepts/child_process.md)

### Getting Started

- [Install the SDK](/client-sdk/guides/install.md)
- [Base Setup](/client-sdk/guides/base_setup.md)

### Core Features

- [Extract Requests](/client-sdk/guides/extract_requests.md)
- [Manage Findings](/client-sdk/guides/manage_findings.md)
- [Environments and Variables](/client-sdk/guides/environments.md)

### Plugins

- [Install a Plugin](/client-sdk/guides/install_plugin.md)
- [Call a Plugin Function](/client-sdk/guides/call_function.md)
- [Receive Plugin Events](/client-sdk/guides/receive_events.md)
- [Use a Plugin's NPM Spec Package](/client-sdk/guides/spec_typing.md)

### Advanced

- [Call GraphQL Directly](/client-sdk/guides/graphql_direct.md)
- [Custom Cache Implementation](/client-sdk/guides/custom_cache.md)

### Tutorials

- [Client SDK Tutorials](/client-sdk/tutorials.md)

### Client SDK

- [Using the Scanner API](/client-sdk/tutorials/scanner.md)
- [Using the Autorize API](/client-sdk/tutorials/autorize.md)

### Reference

- [Client SDK Reference](/client-sdk/reference.md)

### Cloud

- [Authentication](/client-sdk/reference/authentication.md)
- [API](/client-sdk/reference/api.md)

### Concepts

- [Client SDK Concepts](/client-sdk/concepts.md)

### Authentication

- [Authentication Methods](/client-sdk/concepts/auth_methods.md)
- [Caching of Tokens](/client-sdk/concepts/auth_caching.md)

### Community implementations

- [Golang SDK](/client-sdk/concepts/community_golang.md)
- [Python SDK](/client-sdk/concepts/community_python.md)

### Other

- [Assistant](/plugins/reference/sdks/frontend/assistant.md)
- [Backups](/plugins/reference/sdks/frontend/backups.md)
- [caido/crypto](/plugins/reference/modules/caido/crypto.md)
- [caido/http](/plugins/reference/modules/caido/http.md)
- [Certificate](/plugins/reference/sdks/frontend/certificate.md)
- [Client SDK Guides](/client-sdk/guides.md)
- [constants](/plugins/reference/modules/llrt/fs/namespaces/constants.md)
- [Developer Policy](/policy.md)
- [export=](/plugins/reference/modules/llrt/path/namespaces/export=.md)
- [Exports](/plugins/reference/sdks/frontend/exports.md)
- [extra/console](/plugins/reference/modules/extra/console.md)
- [extra/os](/plugins/reference/modules/extra/os.md)
- [extra/sqlite](/plugins/reference/modules/extra/sqlite.md)
- [extra/timers](/plugins/reference/modules/extra/timers.md)
- [llrt/abort](/plugins/reference/modules/llrt/abort.md)
- [llrt/buffer](/plugins/reference/modules/llrt/buffer.md)
- [llrt/child\_process](/plugins/reference/modules/llrt/child_process.md)
- [llrt/dns](/plugins/reference/modules/llrt/dns.md)
- [llrt/dom-events](/plugins/reference/modules/llrt/dom-events.md)
- [llrt/events](/plugins/reference/modules/llrt/events.md)
- [llrt/fs](/plugins/reference/modules/llrt/fs.md)
- [llrt/fs/promises](/plugins/reference/modules/llrt/fs/promises.md)
- [llrt/globals](/plugins/reference/modules/llrt/globals.md)
- [llrt/https](/plugins/reference/modules/llrt/https.md)
- [llrt/net](/plugins/reference/modules/llrt/net.md)
- [llrt/path](/plugins/reference/modules/llrt/path.md)
- [llrt/process](/plugins/reference/modules/llrt/process.md)
- [llrt/stream](/plugins/reference/modules/llrt/stream.md)
- [llrt/stream/web](/plugins/reference/modules/llrt/stream/web.md)
- [llrt/string\_decoder](/plugins/reference/modules/llrt/string_decoder.md)
- [llrt/url](/plugins/reference/modules/llrt/url.md)
- [Net](/plugins/reference/sdks/backend/net.md)
- [Net](/plugins/reference/sdks/workflow/net.md)
- [process](/plugins/reference/modules/llrt/process/process.md)
- [QuickJS](/plugins/reference/modules/llrt/globals/namespaces/QuickJS.md)
- [Response](/plugins/reference/sdks/frontend/response.md)
- [Settings](/plugins/reference/sdks/frontend/settings.md)
- [stream](/plugins/reference/modules/llrt/stream/stream.md)
- [stream/web](/plugins/reference/modules/llrt/stream/web/stream/web.md)
- [url](/plugins/reference/modules/llrt/url/url.md)
- [Websockets](/plugins/reference/sdks/frontend/websockets.md)