Getting Started

Run asyncat from source or learn about upcoming desktop installers.

Run from Source (Developer Mode)

To run asyncat in developer mode with hot-reloading:

# Clone the repository
git clone https://github.com/asyncat-oss/asyncat-oss.git
cd asyncat-oss

# Install dependencies
npm install

# Rebuild native SQLite/Puppeteer modules for Electron's Node version
npm run electron:rebuild

# Launch dev server + Electron app
npm run electron:dev

Desktop Installers (Coming Soon)

Pre-built desktop packages (.dmg, .exe, .AppImage, .deb) are not yet hosted/available, but they will be downloadable from the latest Releases page in a future release:

macOS: Download the .dmg package (x64 / arm64 Apple Silicon)
Windows: Download the .exe installer
Linux: Download the .AppImage or .deb package

⚠️ Code Signing Warnings

Since asyncat is open-source and unsigned, your operating system will show a warning on first launch. This is expected and easily bypassed:

macOS:

If it says "Apple cannot check it for malicious software": Right-click (or Ctrl+click) Asyncat.app, choose Open, and then click Open in the dialog.
Alternatively, go to System Settings → Privacy & Security, scroll down to the Security section, and click Open Anyway.

Windows:

If SmartScreen says "Windows protected your PC": Click More info, then click Run anyway.

Linux:

chmod +x Asyncat-*.AppImage
./Asyncat-*.AppImage

Requirements

No prerequisites are required to use the pre-built installers.

If running from source, you will need:

Dependency	Version	Required	Note
`Node.js`	20.19+, 22.13+, or 24+	✓	Runs the backend environment and Electron packaging
`git`	any	✓	Used to clone the repository
`Python`	3.10+	○	Only if using a managed local engine fallback

Next steps

Introduction — understand asyncat's architecture
Skills — bundled agent capabilities
Memory — how the agent retains context
FAQ — answers to common questions