Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 2.55 KB

README.md

File metadata and controls

58 lines (38 loc) · 2.55 KB

Stealth Logo

Stealth is a Ruby framework for creating text and voice chatbots. It's design is inspired by Ruby on Rails's philosophy of convention over configuration. It has an MVC architecture with the slight caveat that views are aptly named replies.

CircleCI Gem (including prereleases)

Features

  • Deploy anywhere, it's just a Rack app
  • Variants allow you to use a single codebase on multiple messaging platforms
  • Structured, universal reply format
  • Sessions utilize a state-machine concept and are Redis backed
  • Highly scalable. Incoming webhooks are processed via a Sidekiq queue
  • Built-in best practices: catch-alls (error handling), hello flows, goodbye flows

Getting Started

Getting started with Stealth is simple:

> gem install stealth
> stealth new <bot>

Service Integrations

Stealth is extensible. All service integrations are split out into separate Ruby Gems. Things like analytics and natural language processing (NLP) can be added in as gems as well.

Currently, there are gems for:

Messaging

Voice

Natural Language Processing

Analytics

Docs

You can find our full docs here. If something is not clear in the docs, please file an issue! We consider all shortcomings in the docs as bugs.

Versioning

Stealth is versioned using Semantic Versioning, but it's more like the Linux Kernel. Major version releases are just as arbitrary as minor version releases. We strive to never break anything with any version change. Patches are still issues as the "third dot" in the version string.

License

"Stealth" and the Stealth logo are Copyright (c) 2017-2024 MAV Automated Ventures Inc.