Skip to content

Latest commit

 

History

3,739 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kylrix Logo

Build, ship and think in one living agentic workspace.

Your workflow becomes a living, scalable system that compounds daily leverage over time.

Open source · Self-hostable · Local-first · Optional encryption

AGPL-3.0-or-later · Architecture · kylrix.space · API Docs

smithery badge

TL;DR

  • Kylrix — open-source, local-first workspace for notes, goals, workspaces, chat, vault, and agents.
  • Use the cloudkylrix.space
  • Self-hostcurl -fsSL https://raw.githubusercontent.com/Kylrix/kylrix/master/selfhost.sh | bash → app on :5003
  • Wire an agent — mint a PAT (your workspace) or agent key (its own workspace), then npx skills add kylrix/kylrix --skill mcp --skill api --skill agents

Sponsor

Sponsor


Self-host

Agent skill:

npx skills add kylrix/kylrix --skill selfhost

Configure (optional — omit to auto-mint admin credentials into .env):

export SELFHOST_ADMIN_EMAIL=you@example.com
export SELFHOST_ADMIN_PASSWORD='your-secure-password'

Install (bundled Appwrite + Kylrix, no cloud backend):

curl -fsSL https://raw.githubusercontent.com/Kylrix/kylrix/master/selfhost.sh | bash
Default
App http://localhost:5003
Appwrite API http://localhost:8080/v1

More: SELFHOST.md · re-run ./selfhost.sh anytime (detects drift, skips healthy steps).


Develop

git clone https://github.com/Kylrix/kylrix.git
cd kylrix
cp env.sample .env

Install Ota (execution contract for this repo):

curl -fsSL https://dist.ota.run/install.sh | sh

Run:

ota doctor
ota up --workflow dev          # local app → http://localhost:3005
ota up --workflow verify       # lint + test + build

Contract: ota.yaml · schema: appwrite.config.json


Humans & agents

Humans and agents share the same workspace. MCP for IDE tool loops; REST for scripts, mobile, and CI.

Choose auth

Token Use when
PAT (kyl_pat_…) The agent acts in your workspace (IDE tools, scripts, MCP on your behalf). Settings → Developers
Agent key (kyl_apk_…) The agent gets its own workspace — it provisions itself and mints its own PAT. Settings → Smart Agents
Surface Use when
WebMCP (navigator.modelContext) In-browser agents (Chrome, ChatGPT browser) with zero-config live session tools
MCP IDE agents (Cursor, Claude, Windsurf, Codex, …)
REST API (/api/v1) Scripts, mobile apps, CI, custom backends

Steps

  1. Mint a tokenPAT (your workspace) or agent key (agent workspace)
  2. Install skills
    npx skills add kylrix/kylrix --skill mcp --skill api --skill agents
  3. Connect MCP (IDE only — uses your PAT; Smithery wires the official endpoint)
    npx -y @smithery/cli install kylrix/kylrix --client cursor
  4. Browser Agents (WebMCP) — Auto-exposed via navigator.modelContext with zero config in your live session:
    await navigator.modelContext.executeTool('kylrix_create_note', {
      title: 'Agent Note',
      content: 'Created via in-browser modelContext',
      tags: ['webmcp']
    });
    Test: Enable chrome://flags/#enable-webmcp-testing in Chrome, browse via ChatGPT, or click the WebMCP badge in Settings → Developers.

Wiring reference: docs/integrations.md · docs/webmcp.md


Integrations

Link
WebMCP (W3C in-browser) docs/webmcp.md · navigator.modelContext
MCP Humans & agents above · docs/mcp.md
REST API docs/api.md · https://www.kylrix.space/api/v1
Sign in with Kylrix (OAuth 2.1) docs/oauth2.md
SDK sdk/ in this repo
Flows Extensible layers inside Kylrix — kylrix.space/flows

What ships in the box

Area What
Notes & ideas Linked notes, tags, sharing
Goals Goal tracking and focus sessions
Events Calendar and scheduling
Forms Build forms and collect responses
Flows Installable workflow plugins (kylrix.space/flows)
Workspaces Projects, collaborators, permissions
Connect Chats, moments, group hangouts
Vault Client-encrypted credentials (optional)
Agents In-workspace sessions with tool parity to users

Local copy is the default source of truth; sync confirms in the background.


Feedback & security

Bug report form · ARCHITECTURE.md

Releases

Sponsor this project

Packages

Contributors

Languages