Skip to main content

Xircuits Documentation

If you're looking to learn more about Xircuits, you're in the right place. We've provided extensive documentation to support you.

First Steps

Are you new to Xircuits? Here's some quick links to start!

How the Xircuits Documentation is Organized

Here's high-level overview of how the documentation is organized to help you know where to look for certain things:

  • Tutorials take you by the hand and get you started on your first Xircuits workflows. Start here if you're new to Xircuits.
  • How-Tos offer step-by-step instructions for specific tasks and challenges you might encounter, including how to perform programming tasks using Xircuits' visual style (loops, variables, events, etc.).
  • Explanations discuss key topics and concepts at a fairly high level and provide useful background information and explanation.
  • Developer Guide contains guides so that you can create components and workflows for Xircuits users, including how you can contribute to Xircuits.
  • References contain detailed descriptions of Xircuits' machinery and commands.
  • FAQs provide answers to frequently asked questions.
  • Component Library provides individual component library references.
  • Project Templates offers specific use case implementations and examples.

Why Should I Use Xircuits?

Xircuits offers unique benefits tailored to different types of users:

  • For Users: Run our project templates with minimal or no coding, making it easy to implement AI workflows quickly and efficiently. You don't need a PhD to run AI!
  • For Developers: Develop your own workflows visually, allowing for more intuitive and efficient creation and modification of complex processes. Explain your work to bosses easily with powerful visual tools!
  • For Enterprises: Use the Xircuits Platform to deploy and integrate AI features swiftly, without the need for extensive development time. Fast and easy integration - you don't need a huge team!

Getting Help

Having trouble? We'd like to help!

  • Try the FAQ – it's got answers to many common questions.
  • See if your issue has been found and solved before in the Github Issues page.
  • Need direct support? You can always visit our Discord.