Canvas plugin reference | Apus Ami

Get started

Overview
First steps
Setup guides and reference

Install

Install overview
- index
- installer
Runtimes
Maintenance
- backups
- updating
- Updating
- update-troubleshooting
- Migrating
- uninstall
- development-channels
Containers
Hosting
- vps
- App platforms
- Cloud servers
- Self-hosted and local
Advanced setup
- setup

Channels

Overview
- index
Mainstream messaging
Developer and self-hosted
Regional platforms
Configuration

Agents

Agent runtime
Agent workspace
Sessions and memory
Multi-agent
Messages and delivery

Capabilities

Overview
- index
Plugins
Plugin guides
- agentsapi
- Codex
- copilot
- Meetings and calls
- Models and memory
- Secrets and vaults
  - onepassword
  - vault
- Automation and integrations
Building plugins
- building-plugins
- feature-plugins
- tool-plugins
- sdk-channel-plugins
- Channel plugins
- sdk-provider-plugins
- Provider plugins
- cli-backend-plugins
- hooks
- Plugin hooks
- plugin-permission-requests
- adding-capabilities
Skills
Automation
- index
- heartbeat
- cron-jobs
- Automations
- imap
- standing-orders
- hooks
- Hooks
Tools
- Running code and approvals
- Media and documents
  - media-overview
  - image-generation
  - music-generation
  - pdf
  - tts
  - Text to speech
    quickstart
    configuration
    personas
    commands
    output
    field-reference
    api
  - video-generation
- Tool catalogs and workflows
- Context and reasoning
- Chat and UI tools
- Browsing and fetching pages
- Web search
Agent coordination
- agent-send
- goal
- steer
- subagents
- Sub-agents
- swarm
- acp-agents
- ACP agents
- acp-agents-setup
- multi-agent-sandbox-tools

ClawHub

Overview
Using ClawHub
API and trust

Models

Overview
- index
- models
Concepts and configuration
Providers
- Chat and coding models
- Speech and audio
- Image, video, and music
- Gateways and routers
- Local runtimes

Platforms

Platforms overview
macOS companion app
- Setup
- Runtime
- Features

Gateway & Ops

Gateway
- index
- Configuration
- Authentication and secrets
- Health and diagnostics
- Scaling and operations
- Security and sandboxing
- Protocols and APIs
- Models and local providers
- Networking and discovery
Remote access
Security
Nodes and media
- index
- pairing-and-status
- node-host
- node-exec
- mcp-and-skills
- session-hosting
- session-catalogs
- file-transfers
- command-policy
- device-commands
- presence
- troubleshooting
- Media capabilities
- Node features
  - computer-use
  - talk
  - Talk mode
    realtime-sessions
    session-ownership
    macos-relay
    client-ui
  - voicewake
  - location-command
Web interfaces

Reference

CLI commands
- index
- Running the service
  - daemon
  - gateway
  - Gateway
    running
    restart-and-supervision
    query
    service
    discovery
  - health
  - logs
  - status
- Setup and maintenance
- Diagnostics and security
- Agents, models, and sessions
- Events and audit records
- Channels and messaging
- Tools and execution
- Configuration
- Plugins and skills
  - plugins
  - Plugins CLI
    authoring
    install
    list
    uninstall-and-update
    inspect-and-diagnose
    marketplace
  - file-transfer
  - path
  - policy
  - Policy
    authoring
    rules
    scopes
    running-checks
    attestation
    findings
  - skills
  - workboard
- Interfaces
- Utility
  - acp
  - clawbot
  - completion
  - dns
  - docs
  - mcp
  - MCP
    serve
    registry
    json-output
    transports
    control-ui
    apps
  - proxy
RPC and API
- rpc
Codex runtime reference
- codex-harness-reference
- Codex harness reference
- codex-harness-runtime
- Codex harness runtime
Plugin reference
Plugin SDK reference
- sdk-overview
- Plugin SDK overview
- manifest
- Plugin manifest
- sdk-subpaths
- sdk-entrypoints
- Plugin entry points
- sdk-runtime
- Plugin runtime helpers
- sdk-agent-harness
- Agent harness plugins
- sdk-setup
- sdk-testing
Plugin internals
- architecture
- architecture-internals
- Plugin architecture internals
- sdk-migration
- Plugin SDK migration
- compatibility
- install-overrides
- sdk-channel-outbound
- sdk-channel-inbound
- sdk-channel-ingress
- message-presentation
Templates
- AGENTS.default
- AGENTS
- BOOT
- BOOTSTRAP
- IDENTITY
- SOUL
- USER
- Dev agent templates
- Retired workspace files
  - HEARTBEAT
  - TOOLS
Technical reference
Schemas and formatting
- typebox
- markdown-formatting
Project and contributing
- credits
- pull-request-review-flow

Releases

Release notes
Release process
- RELEASING
- full-release-validation
- Full release validation
- release-performance-sweep
- dependency-locking

Contributing

Maturity
- scorecard
- taxonomy
Testing and CI
- test
- Tests
- ci
- CI
  - pipeline
  - watching-runs
  - checkout
  - scope-and-routing
  - Scope and routing
    selection
    node-test-lanes
    job-budgets
    manual-dispatches
  - runners
  - capacity
  - release-validation
  - Release validation
    full-release-validation
    live-and-e2e-shards
    package-acceptance
    install-smoke-and-docker-e2e
    plugin-prerelease
  - scheduled-workflows
  - local-proof
- scripts
- qa-e2e-automation
- QA stack
- personal-agent-benchmark-pack
- testing
- Testing guide
- testing-updates-plugins
- testing-live
- Live testing guide
- mantis
- mantis-slack-desktop-runbook

Help

Start here
FAQ
Diagnostics
- environment
- flags
Community and meta
- lore

Presents hosted widget documents on paired macOS panels.

Distribution

Package: @apus/canvas-plugin
Install route: included in Apus

Surface

Contracts: tools
Skills