All versions of this documentation

Playground & editor for Ogma

Interactive playground and editor for Ogma

With the release of Ogma 3.2 we’re happy to introduce a new feature on our website that will simplify development with Ogma. There are many examples on the website that help demonstrate the capabilities of Ogma. Now, every example can be edited live within your browser which will allow you to save and share the results, all through a single, secure link*.

You can check out the new feature on the Ogma Playground.

How can I leverage the new Ogma Playground?

With this new feature, you’re able to develop prototypes directly within our documentation website. You can also change the examples to test your ideas or to try out new styles. Just pick an example of the documentation and adapt it to your needs so it kickstarts the development of your project.

By using the Ogma Playground, you’ll also benefit from more streamlined support. It’s now much easier to share any challenges with our support team by simply using the URL of your browser.

How does the editor work?

The editor features the full power of autocomplete based on the Ogma code and documentation, so you can write the code faster and you won’t get lost in various API methods and signatures: it’s also a nice way of starting to learn Ogma without having to set up the environment!

Code auto-complete

Code auto-completion speeds up the process of coding by reducing typos and other common mistakes. A popup may appear when typing, suggesting a list of functions and their parameters, types, variables, usage examples, documentation, etc.

Hot reloading

The editor also features hot-loading which will update the preview 3s after each code change (or instant-reload by pressing CTRL / CMD + S).

Adding files to the playground.

You can add a .json or .js, .ts files to the playground using the 'Add new' button. You can then require or load them in your code. See example in the playground. This way you can play around with the exempts of your data and add isolated code snippets to re-use them in your prototype.

Download and run your code locally

You can also download all your code in a zip file (ready to run) by clicking the download button. The resulting archive contains a boilerplate for your project using parcel bundler. Ogma is not included in the archive, you will have to download it from To do that, you just need to edit your API key in the package.json file and npm will download it for you when you do npm install. After that, all you need to run your project locally is to run npm start.

Sharing your code and support

You can share the editor links with your colleagues and with Ogma support. This is the best way to share your challenges and code issues with us and get the support. No more archives and badly formatted pieces of code in your emails: just reproduce your solution in the playground, add a safe piece of data and paste the link into the support message. We will see the issue, edit the code and send you back the solution!

Stay tuned for new updates!

We are constantly working on improving the developer experience with Ogma, if you have any questions or would like to learn more about these updates, feel free to contact us!

Technical note about security

  • Note that we never upload or store any of your data on our servers. Your data and source code are encoded in the link and are transmitted with it. It is therefore strongly advised not to share links with your confidential data in the editor.