API & SDK
Connect your tools to Armalo
Everything on this page is written from your side of the connection: sign in with your own account, connect a repository, and call the public endpoints. Your keys stay scoped to your workspace, and you can revoke them at any time.
What you can connect
The CLI. Install the Armalo CLI from npm with the @app tag: npm install --global @armalo/cli@app. Always use the tag: @armalo/cli without it installs a different product. You can also work in the App, or connect from Settings → Developer when you use your own tools.
The SDK. A typed client for building against Armalo from your own code. It is not on the npm registry yet; the SDK guide covers what it does and how it is used.
Your own developer tools. Connect once from Settings → Developer and work in the tools you already use. The developer shell guide has the full reference.
Sign in with your account
In the browser, you sign in with your Armalo account. For the CLI and your own tools, create an API key in Settings → Developer and sign in with it. A key works only inside your workspace, and you can revoke it from the same settings page whenever you like.
armalo login
# or non-interactive:
armalo login --key ak_live_... --base-url https://api.armalo.aiConnect a repository
Connect GitHub from your workspace settings. Armalo installs as a GitHub App on only the repositories you pick, so your AI Cofounder can work in your codebase — reading the code, making changes, and opening pull requests for your review. You can disconnect a repository at any time from the same settings.
Public endpoints
These are the endpoints your own code and tools can call:
- GET /api/healthCheck whether Armalo is up. No key needed.
- GET /api/github/connect/startBegin connecting a GitHub account from your workspace. The flow returns you to Armalo when you finish.
With an API key, the developer-shell endpoints on api.armalo.ai start, list, read, and stop your shells:
- POST /v1/dev/sandboxesStart a developer shell.
- GET /v1/dev/sandboxesList your live shells.
- GET /v1/dev/sandboxes/:idRead one shell.
- DELETE /v1/dev/sandboxes/:idStop a shell. Your files stay saved.
The developer shell guide documents each call in full.
Events from your providers
When something happens in a tool you connected — a payment lands, code is pushed — the provider tells Armalo, and Armalo checks the event really came from that provider before acting on it. You see the result in your workspace. There is nothing to configure beyond connecting the tool; the integration guides show the current status for each connection.