- Title
- Status
- Foreword
- Introduction
- Terminology
- Part I - Getting Started
- 1. Build and Install
- 1.1. Requirements
- 1.2. Build from Source
- 1.3. Install the Engine
- 2. Create Your First Robot
- 2.1. Local Workstation Workflow
- 2.2. Run the Default Robot
- 2.3. Robot Repository Layout
- 2.4. Connector Credentials
- 2.4.1. Slack Socket Mode
- 3. Run and Deploy Your Robot
- 3.1. Deployment Environment Variables
- 3.2. Run with systemd
- 3.3. Container Deployment
- 3.3.1. Docker Example
- 3.3.2. Kubernetes Example
- Part II - Operating a Robot
- 4. Daily Usage
- 4.1. Addressing the Robot
- 4.2. Command Matching
- 4.3. Channels, DMs, and Threads
- 4.4. Finding Commands with Help
- 4.5. Built-in Commands
- 4.6. Message Context
- 5. Administration and Day 2 Operations
- 5.1. Updating and Reloading
- 5.2. Administrative Commands
- 5.3. Logging
- 6. Security and Access Control
- 6.1. User Approval Elevation
- Part III - Writing Automation
- 7. Extending Your Robot
- 7.1. Your First Plugin
- 7.2. Configuration Style Guide
- 7.3. Writing Good Help Text
- 7.4. Local Authoring Workflow
- 7.5. CLI Tools for Authors
- 7.6. Secrets and Parameters
- 8. Pipelines, Jobs, and Tasks
- 8.1. Primary Pipelines
- 8.2. Final Pipelines
- 8.3. Fail Pipelines
- 8.4. Task Environment
- 8.5. Included Tasks
- Part IV - Reference
- 9. Configuration Reference
- 9.1. Configuration Overview
- 9.2. robot.yaml Reference
- 9.3. Plugin Config Reference
- 9.4. Config Templates
- 9.5. Environment Variables
- 9.6. Troubleshooting
- 10. Command Authoring Reference
- 10.1. SimpleMatcher
- 11. BasicMarkdown Reference
- 12. Robot API Overview
- 12.1. Language Choices
- 12.2. Attribute Retrieval
- 12.3. Message Sending and Formatting
- 12.4. Prompting for Replies
- 12.5. Memory and Brain Methods
- 12.6. Pipeline Methods
- 12.7. Utility Methods
- 12.8. Miscellaneous Methods
- 13. Upgrading Existing Robots
- 14. Appendix
- 14.1. Protocols
- 14.1.1. Slack