https://github.com/canvas-ai/canvas-electron
Context layer on top of your unstructured universe
https://github.com/canvas-ai/canvas-electron
ai documentdb electron index javascript lmdb nodejs notes productivity productivity-tools rag svelte tabs-management
Last synced: 18 days ago
JSON representation
Context layer on top of your unstructured universe
- Host: GitHub
- URL: https://github.com/canvas-ai/canvas-electron
- Owner: canvas-ai
- License: agpl-3.0
- Created: 2022-10-30T08:29:18.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-12-29T21:42:56.000Z (about 1 month ago)
- Last Synced: 2026-01-01T23:26:05.792Z (about 1 month ago)
- Topics: ai, documentdb, electron, index, javascript, lmdb, nodejs, notes, productivity, productivity-tools, rag, svelte, tabs-management
- Language: TypeScript
- Homepage: https://getcanvas.org
- Size: 19.9 MB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Canvas UI
## Downloads
- **Latest release (recommended)**: [Latest release](https://github.com/canvas-ai/canvas-electron/releases/latest)
- **All releases**: [All releases](https://github.com/canvas-ai/canvas-electron/releases)
### Config/Data Storage
- **Linux/Mac**: `~/.canvas/electron/agents//`
- **Windows**: `%APPDATA%/Canvas/electron/agents//`
- **Format**: Plain JSON files with datetime stamps
- **Structure**: `YYYY-MM-DDTHH-mm-ss-conversation.json`
## Development
### Prerequisites
- Node.js 20.x or higher
- npm or yarn package manager
### Setup
```bash
# Clone the repository
git clone
cd canvas
# Install dependencies
npm install
# Development mode
npm run dev
# Build for production
npm run build
# Package the application
npm run package
```
### Development Scripts
- `npm run dev` - Start both main and renderer in development mode
- `npm run dev:main` - Build and run main process only
- `npm run dev:renderer` - Start Vite dev server for renderer
- `npm run build` - Build both main and renderer for production
- `npm run build:main` - Build main process only
- `npm run build:renderer` - Build renderer only
- `npm run lint` - Run ESLint on all TypeScript files
- `npm run type-check` - Run TypeScript type checking
### Development Build
```bash
npm run build
```
### How to cut a release
Tag and push (tag should match our versioning convention):
```bash
git tag v2.0.0-alpha.1
git push origin v2.0.0-alpha.1
```
GitHub Actions will build + create a Release with the installers.
### Production Package
```bash
npm run package
```
This creates platform-specific packages in the `release/` directory:
- **Linux**: AppImage
- **Windows**: NSIS installer
- **macOS**: DMG file
## License
AGPL-3.0-or-later - see LICENSE file for details.
## Roadmap
- [ ] Main management app