Quickstart
Run your first Modus app in a few minutes
In this quickstart we’ll show you how to get set up with Modus and its CLI and build a simple app that fetches a random quote from an external API. You’ll learn how to use the basic components of a Modus app and how to run it locally.
Prerequisites
- Node.js - v22 or higher
- Text editor - we recommend VS Code
- Terminal - access Modus through a command-line interface (CLI)
Building your first Modus app
Install the Modus CLI
The Modus CLI provides a set of commands to help you create, build, and run your Modus apps. Install the CLI using npm.
Initialize your Modus app
To create a new Modus app, run the following command in your terminal:
This command prompts you to choose between Go and AssemblyScript as the language for your app. It then creates a new directory with the necessary files and folders for your app. You will also be asked if you would like to initialize a Git repository.
Build and run your app
To build and run your app, navigate to the app directory and run the following command:
This command runs your app locally in development mode and provides you with a URL to access your app’s generated API.
Access your local endpoint
Once your app is running, you can access the graphical interface for your API at the URL located in your terminal.
The API Explorer interface allows you to interact with your app’s API and test your functions.
Add a connection
Modus is a secure-by-default framework. To connect to external services, you need to add a connection in your app manifest.
Add the following code into your modus.json
manifest file:
Add a model
Modus also supports AI models. You can define new models in your modus.json
file. Let’s add a new meta-llama model:
Install the Hyp CLI and log in
Next, install the Hyp CLI. This allows you to access hosted models on the Hypermode platform.
You can now use the hyp login
command to log in to the Hyp CLI.
This links your project to the Hypermode platform, allowing you to leverage the model in your modus app.
Add a function with AI integration
Functions are the building blocks of your app. Let’s add a function that fetches a random quote from the ZenQuotes connection and uses AI to generate a summary for the quote.
Create a new file in the root directory with the following code:
Create a new file in the root directory with the following code:
Create a new file in the assembly
directory with the following code:
Then add the following to index.ts
. This includes the getRandomQuote
function on
your generated API.
Make your first AI call
Now that you’ve integrated the AI model, let’s test it! After adding your function, restart your development server:
Navigate to the API Explorer at http://localhost:8686/explorer
and you’ll see your randomQuote
function available to test.
When you call the function, you’ll notice that the quote includes three fields:
quote
: The original quote textauthor
: The author’s namesummary
: An AI-generated summary that captures the essence of the quote
The AI model analyzes the quote and provides insightful context about its meaning, making your app more engaging and informative for users.
Try calling the function multiple times to see how the AI generates different summaries for various quotes!
Track local model inferences
When testing an AI app locally, Modus records the inference and related metadata
in the View Inferences
tab of the APIs explorer.
Local model tracing is only supported on Linux and macOS. Windows support is coming soon.
You can now see detailed information about each AI model call, including:
- Input prompts sent to the model
- Generated responses
- Performance metrics like response time
- Token usage and costs
For more inspiration, check out the Modus recipes.