https://github.com/hypermodeinc/modus
Modus: an open source, serverless framework for building intelligent functions and APIs, powered by WebAssembly
https://github.com/hypermodeinc/modus
ai api go javascript serverless webassembly
Last synced: 19 days ago
JSON representation
Modus: an open source, serverless framework for building intelligent functions and APIs, powered by WebAssembly
- Host: GitHub
- URL: https://github.com/hypermodeinc/modus
- Owner: hypermodeinc
- License: apache-2.0
- Created: 2023-10-28T04:31:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-13T05:03:07.000Z (5 months ago)
- Last Synced: 2024-11-13T09:06:16.838Z (5 months ago)
- Topics: ai, api, go, javascript, serverless, webassembly
- Language: Go
- Homepage: https://docs.hypermode.com/modus
- Size: 4.8 MB
- Stars: 187
- Watchers: 3
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- trackawesomelist - Modus (⭐181) - An open source, serverless framework for building intelligent functions and APIs, powered by WebAssembly. (Recently Updated / [Nov 18, 2024](/content/2024/11/18/README.md))
README
[](https://github.com/hypermodeinc/modus)
[](https://github.com/hypermodeinc/modus?tab=Apache-2.0-1-ov-file#readme)
[](https://discord.gg/NJQ4bJpffF)
[](https://github.com/hypermodeinc/modus/stargazers)
[](https://github.com/hypermodeinc/modus/commits/main/)
Get Started
·
Docs
·
Discord
**Modus is an open-source, serverless framework for building agentic systems and AI apps in
Go and AssemblyScript**
It simplifies the integration of models, context, and data. We're continuing to add additional
capabilities to better support the construction and calling of tools.
You write a function.
```ts
export function sayHello(name: string): string {
return `Hello, ${name}!`;
}
```
Then, Modus:
- extracts the metadata of your functions
- compiles your code with optimizations based on the host environment
- caches the compiled module in memory for fast retrieval
- prepares an invocation plan for each function
- extracts connections, models, and other configuration details from the app’s manifest
- generates an API schema and activates the endpoint
You query the endpoint
```graphql
query SayHello {
sayHello(name: "World")
}
```
In a few milliseconds, Modus:
- loads your compiled code into a sandboxed execution environment with a dedicated memory space
- runs your code, aided by host functions that power the Modus APIs
- securely queries data and AI models as needed, without exposing credentials to your code
- responds via the API result and releases the execution environment
**Now you have a production ready scalable endpoint for your AI-enabled app. AI-ready when you’re
ready. Launch and iterate.**
## Quickstart
Install the Modus CLI
```bash
npm install -g @hypermode/modus-cli
```
Initialize your Modus app
```bash
modus new
```
Run your app locally with fast refresh
```bash
modus dev
```
## Demo
[](https://www.youtube.com/watch?v=3CcJTXTmz88)
## What's it good for?
We believe that agentic flows are still fundamentally apps. As such, we've designed Modus
primarily as a general-purpose framework, that just happens to treat models, agents, and tools as
first-class components.
Modus is optimized for apps that require sub-second response times. We’ve made trade-offs to
prioritize speed and simplicity.
## Programming Languages
Since Modus is based on WebAssembly, you can write Modus apps in various programming languages. Each
language offers the full capabilities of the Modus framework.
Currently, the supported languages you may choose from are:
- [Go](https://go.dev/) - A general-purpose programming language originally designed by Google.
- [AssemblyScript](https://www.assemblyscript.org/) - A TypeScript-like language designed for
WebAssembly.
Additional programming languages will be supported in the future.
## Hosting
Modus is a free, open-source framework, you’re welcome to run your Modus apps on your own hardware
or on any hosting platform that meets your needs.
However, over at [Hypermode](https://hypermode.com/) we have built additional tooling and
infrastructure to make constructing and deploying your agents and AI apps easy. Hypermode
includes models, observability, debugging, and function hosting. Just push your code to Github and
Hypermode will automatically build and deploy it on global infrastructure.
## Open Source
Modus is developed by [Hypermode](https://hypermode.com/) as an open-source project, integral but
independent from Hypermode.
We welcome external contributions. See the [CONTRIBUTING.md](./CONTRIBUTING.md) file if you would
like to get involved.
## Acknowledgements
It's taken a lot of hard work to bring Modus to life, but we couldn't have done it alone. Modus is
built upon _many_ open source components and projects. We'd especially like to express our gratitude
to the authors and teams of our core dependencies:
- Takeshi Yoneda, author of [Wazero](https://wazero.io/), and other contributors to the Wazero
project - and to [Tetrate](https://tetrate.io/) for continuing its support of Wazero. Modus uses
Wazero to execute WebAssembly modules.
- Jens Neuse, Stefan Avram, and the rest of the team at [Wundergraph](https://wundergraph.com/).
Modus uses Wundergraph's [GraphQL Go Tools](https://github.com/wundergraph/graphql-go-tools)
library to process incoming GraphQL API requests.
- Max Graey, Daniel Wirtz, and other contributors to the
[AssemblyScript](https://www.assemblyscript.org/) project. Modus chose AssemblyScript as one of
its core languages because it is ideal for web developers getting started with Web Assembly.
- The [Go language](https://go.dev/) team, and also the maintainers of
[TinyGo](https://tinygo.org/). The Modus Runtime is written in Go, and the Modus Go SDK uses
TinyGo.
## License
Modus and its components are Copyright 2024 Hypermode Inc., and licensed under the terms of the
Apache License, Version 2.0. See the [LICENSE](./LICENSE) file for a complete copy of the license.
If you have any questions about Modus licensing, or need an alternate license or other arrangement,
please contact us at [email protected].