CSML Reference
  • Introduction
  • Installing CSML
  • Sending and Receiving Messages
    • Message Payloads
    • Custom Components
  • The Event
  • Memory
    • Using Variables in Messages
    • Temporary and Long-Term variables
    • Global variables
  • Navigating in a CSML Bot
  • Conditional Logic
  • External Code Execution
  • Native CSML Functions
  • Value Types
  • Automatic Type Inference
  • 📑CSML Studio Documentation
  • Standard Library
    • Keywords
    • Built-in Functions
    • HTTP Client
    • SMTP Client
    • Crypto Utilities
      • JWT
      • Hash, HMAC
      • Base64, Hex
    • String methods
    • Array methods
    • Object methods
    • Number methods
    • Generic methods
Powered by GitBook
On this page
  • No installation required: with CSML Playground
  • Install CSML Locally
  • With Docker
  • Using a pre-built CSML Engine binary
  • Compile From Source

Was this helpful?

Edit on Git
Export as PDF

Installing CSML

As an open-source programming language, there are several ways you can get started with CSML, either by compiling the sources yourself, using Docker, or using CSML Studio, a free online development environment provided by Clevy.io.

No installation required: with CSML Playground

The easiest way to create CSML Chatbots is by using the free online development playground available at https://play.csml.dev. No dependencies, no installation, no signup required!

âž¡ Try CSML Playground now on https://play.csml.dev!

You can also create a free account on CSML Studio, a professional online development and deployment tool for all your CSML chatbots. Read more about CSML Studio here, and head over to the Studio documentation!

CSML Studio includes everything you need to create, develop and maintain your chatbots. You get a code editor and test chatbox, built-in services to author functions and install custom or managed integrations, deploy to many different communication channels including Messenger, Workplace Chat, Microsoft Teams, Slack, Whatsapp... and monitor the usage with custom analytics.

âž¡ Try CSML Studio now on https://studio.csml.dev!

Install CSML Locally

To run CSML on your own machine, you will need a way to run the engine (CSML comes with bindings for nodejs or directly in rust), as well as a database. Optionally, you will also need a custom App runtime (more about this on this page).

This blog post explains how to run the CSML engine on your own server. It may be a useful starting point for a custom installation of CSML!

With Docker

We provide an easy-to-use docker image to run CSML on your own computer. To get started, follow the instructions on Docker Hub.

Using a pre-built CSML Engine binary

We provide builds for macOS and linux (arm64) for every new version of the CSML engine. You can find them on the releases page of the CSML Engine github repository. For the latest available version, visit https://github.com/CSML-by-Clevy/csml-engine/releases/latest.

Compile From Source

CSML is written in Rust. You can find the source code of the CSML interpreter and engine on this github repository, and compile it from source as per the instructions.

PreviousIntroductionNextSending and Receiving Messages

Last updated 3 years ago

Was this helpful?