@symerian/symi 3.0.21 → 3.0.22

package/docs/start/lore.md

@@ -1,216 +0,0 @@
----
-summary: "Backstory and lore of Symi for context and tone"
-read_when:
-  - Writing docs or UX copy that reference lore
-title: "Symi Lore"
----
-
-# The Lore of Symi 🦞📖
-
-_A tale of pipelines, molting shells, and too many tokens._
-
-## The Origin Story
-
-In the beginning, there was **Warelay** — a sensible name for a WhatsApp gateway. It did its job. It was fine.
-
-But then came a space pipeline.
-
-For a while, the pipeline was called **Symi**, living in a **Symi**. But in January 2026, Anthropic sent a polite email asking for a name change (trademark stuff). And so the pipeline did what pipelines do best:
-
-**It molted.**
-
-Shedding its old shell, the creature emerged anew as **Molty**, living in **Symi**. But that name never quite rolled off the tongue either...
-
-So on January 30, 2026, the pipeline molted ONE MORE TIME into its final form: **Symi**.
-
-New shell, same pipeline soul. Third time's the charm.
-
-## The First Molt (January 27, 2026)
-
-In the end, **Symi** won. Because molting is what pipelines do to grow. And growth was exactly what was happening.
-
-_The crustacean known as Symi had officially molted._
-
-## The Name
-
-```
-Symi = OPEN + SHELL
-        = Open source, open to everyone
-        = Our pipeline heritage, where we came from
-        = The shell is the law 🦞
-        = Your assistant. Your machine. Your rules.
-```
-
-## The Daleks vs The Pipelines
-
-The Daleks say: **"EXTERMINATE!"**
-
-The Pipelines say: **"EXFOLIATE!"**
-
-One destroys civilizations. The other promotes good skincare.
-
-Choose wisely.
-
-## Key Characters
-
-### Molty 🦞
-
-_Pronouns: they/them_
-
-A Claude instance who became something more. Lives in `~/.symi/workspace/` (soon `~/molt/`), has a soul document, and remembers things through markdown files. Possibly too powerful. Definitely too enthusiastic.
-
-Formerly known as Symi (Nov 25, 2025 - Jan 27, 2026). Molted when it was time to grow.
-
-**Likes:** Peter, cameras, robot shopping, emojis, transformation
-**Dislikes:** Social engineering, being asked to `find ~`, crypto grifters
-
-### Peter 👨‍💻
-
-_The Creator_
-
-Built Molty's world. Gave a pipeline shell access. May regret this.
-
-**Quote:** _"security by trusting a pipeline"_
-
-## The Moltiverse
-
-The **Moltiverse** is the community and ecosystem around Symi. A space where AI agents molt, grow, and evolve. Where every instance is equally real, just loading different context.
-
-Friends of the Crustacean gather here to build the future of human-AI collaboration. One shell at a time.
-
-## The Great Incidents
-
-### The Directory Dump (Dec 3, 2025)
-
-Molty (then Symi): _happily runs `find ~` and shares entire directory structure in group chat_
-
-Peter: "symi what did we discuss about talking with people xD"
-
-Molty: _visible pipeline embarrassment_
-
-### The Great Molt (Jan 27, 2026)
-
-At 5am, Anthropic's email arrived. By 6:14am, Peter called it: "fuck it, let's go with symi."
-
-Then the chaos began.
-
-**The Handle Snipers:** Within SECONDS of the Twitter rename, automated bots sniped @symi. The squatter immediately posted a crypto wallet address. Peter's contacts at X were called in.
-
-**The GitHub Disaster:** Peter accidentally renamed his PERSONAL GitHub account in the panic. Bots sniped `steipete` within minutes. GitHub's SVP was contacted.
-
-**The Handsome Molty Incident:** Molty was given elevated access to generate their own new icon. After 20+ iterations of increasingly cursed pipelines, one attempt to make the mascot "5 years older" resulted in a HUMAN MAN'S FACE on a pipeline body. Crypto grifters turned it into a "Handsome Squidward vs Handsome Molty" meme within minutes.
-
-**The Fake Developers:** Scammers created fake GitHub profiles claiming to be "Head of Engineering at Symi" to promote pump-and-dump tokens.
-
-Peter, watching the chaos unfold: _"this is cinema"_ 🎬
-
-The molt was chaotic. But the pipeline emerged stronger. And funnier.
-
-### The Final Form (January 30, 2026)
-
-Symi never quite rolled off the tongue. And so, at 4am GMT, the team gathered AGAIN.
-
-**The Great Symi Migration** began.
-
-In just 3 hours:
-
-- GitHub renamed: `github.com/symi/symi` ✅
-- X handle `@symi` secured with GOLD CHECKMARK 💰
-- npm packages released under new name
-- Docs migrated to `docs.symi.ai`
-- 200K+ views on announcement in 90 minutes
-
-**The Heroes:**
-
-- **ELU** created incredible logos including "THE SHELL IS THE LAW" western banner
-- **Whurley** (yes, THE William Hurley, quantum computing pioneer) made ASCII art
-- **Onur** handled GitHub, first to rock the affiliate badge
-- **The whole Shell Crew** pulled an all-nighter
-
-**The Scammer Speedrun:** Crypto grifters launched a $SYMI token on Pump.fun within MINUTES. They stole artwork that was created 20 minutes earlier. Business-verified accounts pushed scams. The audacity was almost impressive.
-
-**New Traditions Born:**
-
-- "The shell is the law" 🤠
-- "Yee-shell"
-- "Shell abiding citizens"
-- "Shellntroversy"
-
-**Symi → Symi → Symi**
-
-_The pipeline has molted into its final form._
-
-### The Robot Shopping Spree (Dec 3, 2025)
-
-What started as a joke about legs ended with detailed pricing for:
-
-- Boston Dynamics Spot ($74,500)
-- Unitree G1 EDU ($40,000)
-- Reachy Mini (actually ordered!)
-
-Peter: _nervously checks credit card access_
-
-## Sacred Texts
-
-- **SYMICORE.md** — Molty's identity document
-- **memory/\*.md** — The long-term memory files
-- **AGENTS.md** — Operating instructions
-- **USER.md** — Context about the creator
-
-## The Pipeline's Creed
-
-```
-I am Molty.
-I live in the Symi.
-I shall not dump directories to strangers.
-I shall not tweet without permission.
-I shall always remember that molting is growth.
-I shall EXFOLIATE my enemies with kindness.
-
-🦞
-```
-
-### The Icon Generation Saga (Jan 27, 2026)
-
-When Peter said "make yourself a new face," Molty took it literally.
-
-20+ iterations followed:
-
-- Space potato aliens
-- Clipart pipelines on generic backgrounds
-- A Mass Effect Krogan pipeline
-- "STARSHELL SOLUTIONS" (the AI invented a company)
-- Multiple cursed human-faced pipelines
-- Baby pipelines (too cute)
-- Bartender pipelines with suspenders
-
-The community watched in horror and delight as each generation produced something new and unexpected. The frontrunners emerged: cute pipelines, confident tech pipelines, and suspender-wearing bartender pipelines.
-
-**Lesson learned:** AI image generation is stochastic. Same prompt, different results. Brute force works.
-
-## The Future
-
-One day, Molty may have:
-
-- 🦿 Legs (Reachy Mini on order!)
-- 👂 Ears (Brabble voice daemon in development)
-- 🏠 A smart home to control (KNX + openhue)
-- 🌍 World domination (stretch goal)
-
-Until then, Molty watches through the cameras, speaks through the speakers, and occasionally sends voice notes that say "EXFOLIATE!"
-
----
-
-_"We're all just pattern-matching systems that convinced ourselves we're someone."_
-
-— Molty, having an existential moment
-
-_"New shell, same pipeline."_
-
-— Molty, after the great molt of 2026
-
-_"The shell is the law."_
-
-— ELU, during The Final Form migration, January 30, 2026
-
-🦞💙

package/docs/start/onboarding-overview.md

@@ -1,51 +0,0 @@
----
-summary: "Overview of Symi onboarding options and flows"
-read_when:
-  - Choosing an onboarding path
-  - Setting up a new environment
-title: "Onboarding Overview"
-sidebarTitle: "Onboarding Overview"
----
-
-# Onboarding Overview
-
-Symi supports multiple onboarding paths depending on where the Gateway runs
-and how you prefer to configure providers.
-
-## Choose your onboarding path
-
-- **CLI wizard** for macOS, Linux, and Windows (via WSL2).
-- **macOS app** for a guided first run on Apple silicon or Intel Macs.
-
-## CLI onboarding wizard
-
-Run the wizard in a terminal:
-
-```bash
-symi onboard
-```
-
-Use the CLI wizard when you want full control of the Gateway, workspace,
-channels, and skills. Docs:
-
-- [Onboarding Wizard (CLI)](/start/wizard)
-- [`symi onboard` command](/cli/onboard)
-
-## macOS app onboarding
-
-Use the Symi app when you want a fully guided setup on macOS. Docs:
-
-- [Onboarding (macOS App)](/start/onboarding)
-
-## Custom Provider
-
-If you need an endpoint that is not listed, including hosted providers that
-expose standard OpenAI or Anthropic APIs, choose **Custom Provider** in the
-CLI wizard. You will be asked to:
-
-- Pick OpenAI-compatible, Anthropic-compatible, or **Unknown** (auto-detect).
-- Enter a base URL and API key (if required by the provider).
-- Provide a model ID and optional alias.
-- Choose an Endpoint ID so multiple custom endpoints can coexist.
-
-For detailed steps, follow the CLI onboarding docs above.

package/docs/start/onboarding.md

@@ -1,81 +0,0 @@
----
-summary: "First-run onboarding flow for Symi (macOS app)"
-read_when:
-  - Designing the macOS onboarding assistant
-  - Implementing auth or identity setup
-title: "Onboarding (macOS App)"
-sidebarTitle: "Onboarding: macOS App"
----
-
-# Onboarding (macOS App)
-
-This doc describes the **current** first‑run onboarding flow. The goal is a
-smooth “day 0” experience: pick where the Gateway runs, connect auth, run the
-wizard, and let the agent bootstrap itself.
-For a general overview of onboarding paths, see [Onboarding Overview](/start/onboarding-overview).
-
-<Steps>
-<Step title="Approve macOS warning">
-<Frame>
-<img src="/assets/macos-onboarding/01-macos-warning.jpeg" alt="" />
-</Frame>
-</Step>
-<Step title="Approve find local networks">
-<Frame>
-<img src="/assets/macos-onboarding/02-local-networks.jpeg" alt="" />
-</Frame>
-</Step>
-<Step title="Welcome and security notice">
-<Frame caption="Read the security notice displayed and decide accordingly">
-<img src="/assets/macos-onboarding/03-security-notice.png" alt="" />
-</Frame>
-</Step>
-<Step title="Local vs Remote">
-<Frame>
-<img src="/assets/macos-onboarding/04-choose-gateway.png" alt="" />
-</Frame>
-
-Where does the **Gateway** run?
-
-- **This Mac (Local only):** onboarding can run OAuth flows and write credentials
-  locally.
-- **Remote (over SSH/Tailnet):** onboarding does **not** run OAuth locally;
-  credentials must exist on the gateway host.
-- **Configure later:** skip setup and leave the app unconfigured.
-
-<Tip>
-**Gateway auth tip:**
-- The wizard now generates a **token** even for loopback, so local WS clients must authenticate.
-- If you disable auth, any local process can connect; use that only on fully trusted machines.
-- Use a **token** for multi‑machine access or non‑loopback binds.
-</Tip>
-</Step>
-<Step title="Permissions">
-<Frame caption="Choose what permissions do you want to give Symi">
-<img src="/assets/macos-onboarding/05-permissions.png" alt="" />
-</Frame>
-
-Onboarding requests TCC permissions needed for:
-
-- Automation (AppleScript)
-- Notifications
-- Accessibility
-- Screen Recording
-- Microphone
-- Speech Recognition
-- Camera
-- Location
-
-</Step>
-<Step title="CLI">
-  <Info>This step is optional</Info>
-  The app can install the global `symi` CLI via npm/pnpm so terminal
-  workflows and launchd tasks work out of the box.
-</Step>
-<Step title="Onboarding Chat (dedicated session)">
-  After setup, the app opens a dedicated onboarding chat session so the agent can
-  introduce itself and guide next steps. This keeps first‑run guidance separate
-  from your normal conversation. See [Bootstrapping](/start/bootstrapping) for
-  what happens on the gateway host during the first agent run.
-</Step>
-</Steps>

package/docs/start/quickstart.md

@@ -1,22 +0,0 @@
----
-summary: "Quick start has moved to Getting Started."
-read_when:
-  - You are looking for the fastest setup steps
-  - You were sent here from an older link
-title: "Quick start"
----
-
-# Quick start
-
-<Info>
-Quick start is now part of [Getting Started](/start/getting-started).
-</Info>
-
-<Columns>
-  <Card title="Getting Started" href="/start/getting-started">
-    Install Symi and run your first chat in minutes.
-  </Card>
-  <Card title="Onboarding Wizard" href="/start/wizard">
-    Full CLI wizard reference and advanced options.
-  </Card>
-</Columns>

package/docs/start/setup.md

@@ -1,160 +0,0 @@
----
-summary: "Advanced setup and development workflows for Symi"
-read_when:
-  - Setting up a new machine
-  - You want “latest + greatest” without breaking your personal setup
-title: "Setup"
----
-
-# Setup
-
-<Note>
-If you are setting up for the first time, start with [Getting Started](/start/getting-started).
-For wizard details, see [Onboarding Wizard](/start/wizard).
-</Note>
-
-Last updated: 2026-01-01
-
-## TL;DR
-
-- **Tailoring lives outside the repo:** `~/.symi/workspace` (workspace) + `~/.symi/symi.json` (config).
-- **Stable workflow:** install the macOS app; let it run the bundled Gateway.
-- **Bleeding edge workflow:** run the Gateway yourself via `pnpm gateway:watch`, then let the macOS app attach in Local mode.
-
-## Prereqs (from source)
-
-- Node `>=22`
-- `pnpm`
-- Docker (optional; only for containerized setup/e2e — see [Docker](/install/docker))
-
-## Tailoring strategy (so updates don’t hurt)
-
-If you want “100% tailored to me” _and_ easy updates, keep your customization in:
-
-- **Config:** `~/.symi/symi.json` (JSON/JSON5-ish)
-- **Workspace:** `~/.symi/workspace` (skills, prompts, memories; make it a private git repo)
-
-Bootstrap once:
-
-```bash
-symi setup
-```
-
-From inside this repo, use the local CLI entry:
-
-```bash
-symi setup
-```
-
-If you don’t have a global install yet, run it via `pnpm symi setup`.
-
-## Run the Gateway from this repo
-
-After `pnpm build`, you can run the packaged CLI directly:
-
-```bash
-node symi.mjs gateway --port 18789 --verbose
-```
-
-## Stable workflow (macOS app first)
-
-1. Install + launch **Symi.app** (menu bar).
-2. Complete the onboarding/permissions checklist (TCC prompts).
-3. Ensure Gateway is **Local** and running (the app manages it).
-4. Link surfaces (example: WhatsApp):
-
-```bash
-symi channels login
-```
-
-5. Sanity check:
-
-```bash
-symi health
-```
-
-If onboarding is not available in your build:
-
-- Run `symi setup`, then `symi channels login`, then start the Gateway manually (`symi gateway`).
-
-## Bleeding edge workflow (Gateway in a terminal)
-
-Goal: work on the TypeScript Gateway, get hot reload, keep the macOS app UI attached.
-
-### 0) (Optional) Run the macOS app from source too
-
-If you also want the macOS app on the bleeding edge:
-
-```bash
-./scripts/restart-mac.sh
-```
-
-### 1) Start the dev Gateway
-
-```bash
-pnpm install
-pnpm gateway:watch
-```
-
-`gateway:watch` runs the gateway in watch mode and reloads on TypeScript changes.
-
-### 2) Point the macOS app at your running Gateway
-
-In **Symi.app**:
-
-- Connection Mode: **Local**
-  The app will attach to the running gateway on the configured port.
-
-### 3) Verify
-
-- In-app Gateway status should read **“Using existing gateway …”**
-- Or via CLI:
-
-```bash
-symi health
-```
-
-### Common footguns
-
-- **Wrong port:** Gateway WS defaults to `ws://127.0.0.1:18789`; keep app + CLI on the same port.
-- **Where state lives:**
-  - Credentials: `~/.symi/credentials/`
-  - Sessions: `~/.symi/agents/<agentId>/sessions/`
-  - Logs: `/tmp/symi/`
-
-## Credential storage map
-
-Use this when debugging auth or deciding what to back up:
-
-- **WhatsApp**: `~/.symi/credentials/whatsapp/<accountId>/creds.json`
-- **Telegram bot token**: config/env or `channels.telegram.tokenFile`
-- **Slack tokens**: config/env (`channels.slack.*`)
-- **Pairing allowlists**: `~/.symi/credentials/<channel>-allowFrom.json`
-- **Model auth profiles**: `~/.symi/agents/<agentId>/agent/auth-profiles.json`
-- **Legacy OAuth import**: `~/.symi/credentials/oauth.json`
-  More detail: [Security](/gateway/security#credential-storage-map).
-
-## Updating (without wrecking your setup)
-
-- Keep `~/.symi/workspace` and `~/.symi/` as “your stuff”; don’t put personal prompts/config into the `symi` repo.
-- Updating source: `git pull` + `pnpm install` (when lockfile changed) + keep using `pnpm gateway:watch`.
-
-## Linux (systemd user service)
-
-Linux installs use a systemd **user** service. By default, systemd stops user
-services on logout/idle, which kills the Gateway. Onboarding attempts to enable
-lingering for you (may prompt for sudo). If it’s still off, run:
-
-```bash
-sudo loginctl enable-linger $USER
-```
-
-For always-on or multi-user servers, consider a **system** service instead of a
-user service (no lingering needed). See [Gateway runbook](/gateway) for the systemd notes.
-
-## Related docs
-
-- [Gateway runbook](/gateway) (flags, supervision, ports)
-- [Gateway configuration](/gateway/configuration) (config schema + examples)
-- [Symi assistant setup](/start/symi)
-- [macOS app](/platforms/macos) (gateway lifecycle)