https://github.com/valory-xyz/olas-operate-app
Pearl - Run agents, stake & earn rewards*
https://github.com/valory-xyz/olas-operate-app
agent-runtime olas pearl valory
Last synced: 3 days ago
JSON representation
Pearl - Run agents, stake & earn rewards*
- Host: GitHub
- URL: https://github.com/valory-xyz/olas-operate-app
- Owner: valory-xyz
- License: apache-2.0
- Created: 2024-01-29T12:59:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-05-27T17:04:39.000Z (4 days ago)
- Last Synced: 2026-05-27T17:05:08.487Z (4 days ago)
- Topics: agent-runtime, olas, pearl, valory
- Language: TypeScript
- Homepage: https://olas.network/operate
- Size: 65.8 MB
- Stars: 15
- Watchers: 3
- Forks: 19
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
Pearl
A cross-platform desktop application used to run autonomous agents powered by [Olas](https://olas.network).
## Getting Started
### For Users
#### Downloading the latest release
**Note:** The release pages also contain Source Code `.zip` files. These are not intended for general use. Ignore them unless you're a developer!
- Go to the [Releases](https://github.com/valory-xyz/olas-operate-app/releases) page.
- Download the latest release for your operating system.
- If you're on Windows, download the `.exe` file.
- If you're on MacOS, download the `.dmg` file.
- Both Intel x64 and Apple Silicon ARM64 builds are available.
- Install the application by running the downloaded file.
### For Developers
#### Setting up your development environment
- [Ubuntu Setup Guide](docs/dev/ubuntu-setup.md)
- [MacOS Setup Guide](docs/dev/macos-setup.md)
- [Windows Setup Guide](docs/dev/windows-setup.md)
#### Setting up a development RPC endpoint
- [RPC Setup Guide](docs/dev/rpcs.md)
#### Customizing the service hash
If you want to use a specific service hash, for testing purposes, follow these steps:
1. `./frontend/constants/serviceTemplates.ts`: Ensure that the hash you want to use is correctly referenced in the appropriate service template `hash`.
2. `./frontend/constants/serviceTemplates.ts`: Ensure the service template has corresponding to the hash you update service_version and agent_release.repository.version (you can run `scripts/js/check_service_templates.ts` to check it)
3. `./frontend/config/agents.ts`: Ensure that the corresponding service has `isAgentEnabled: true`.
## Project Dependencies
There are three parts to the project: the Electron app (CommonJS), the NextJS frontend (TypeScript), and the Python backend/middleware.
- [Electron dependencies](package.json)
- [Frontend dependencies](frontend/package.json)
- [Backend dependencies](pyproject.toml)
## License
- [Apache 2.0](LICENSE)
## Security
- [Security Policy](SECURITY.md)