Skip to main content

​
Install the Magma CLI

Our command line interface is the easiest way to create and deploy your agents. You only need to run this once. 
npm i -g @pompeii-labs/cli@latest
This will give you access to the magma command.

​
Authentication

Next we need to log in to Magma. Don’t worry, creating an account is absolutely free! 
magma login
If you already created an account through the Magma dashboard, this will connect your CLI to your account. If you don’t have an account yet, this will create one for you.

​
Create your first agent

You can quickly create a new agent using the init command. This command will set up a template agent with basic starter code. 
magma init
The CLI will guide you through the process of creating your agent.

​
Run your agent locally

Once you’ve initialized your agent, you can run it locally using the run command. This will open an interactive chat session in your terminal.
Look at the .env file in your project, and ensure you set the api key for the provider you are using.
magma run
Have a chat with your agent! When you’re done, simply write quit to stop the chat.

​
Deploy your agent

Once you’ve tested your agent locally and want to deploy it to production, you can use the deploy command: 
magma deploy
That’s it! Your agent will be deployed and available to use in the dashboard.
When you are comfortable with the process of using the CLI, explore the Magma Basics to learn more about the different features and capabilities of Magma. Also check out the Development Guide to learn how to develop and test more advanced features of your agents locally.

Magma Basics

Learn more about the different features and capabilities of Magma

Development Guide

Learn how to develop and test more advanced features of your agents locally