Skip to content
This repository was archived by the owner on May 14, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 133 additions & 0 deletions ARCHIVE-README-original.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
<div align="center">

<img src="assets/spectral-hero.svg" alt="grok-install — Spectral edition" width="100%" />

# grok-install

### *Mint personalized AI agents on X. Safety-first. Owner-consent updates. Open source.*

[![Built with grok-install](badge.svg)](https://github.com/AgentMindCloud/grok-install)
[![License](https://img.shields.io/badge/license-Apache_2.0-FF1E70?style=flat-square&labelColor=0A0A0A)](LICENSE)
[![Spec](https://img.shields.io/badge/spec-v2.13-00E0D5?style=flat-square&labelColor=0A0A0A)](spec/)
[![Safety](https://img.shields.io/badge/safety-tier_1_floor-FF1E70?style=flat-square&labelColor=0A0A0A)](SAFETY.md)
[![Visual System](https://img.shields.io/badge/visual-spectral-00E0D5?style=flat-square&labelColor=0A0A0A)](DESIGN_SYSTEM.md)

</div>

---

**grok-install** is an open-source platform that lets X users mint personalized AI agents from their X profile signal — or pick from a curated template library — and install them natively on X via xAI's `@grok install` standard.

Two paths, same safety floor:

- **Mint from your X signal** — Sign in with X, we analyze your voice and style, you get a one-of-a-kind agent with a unique Genesis ID.
- **Pick a template** — 8 pre-tuned agents covering brand assistant, market signals, creative, dev help, Q&A, daily brief, vibe replies, show notes.

Live demo: [agentmindcloud.github.io/grok-install](https://agentmindcloud.github.io/grok-install/safe-agent-builder.html)

---

## How it works

```
[Configure here] → [Repo created] → [Post on X] → [@grok install] → [Grok greets] → [Lives on your X page]
AUTO AUTO AUTO
```

1. Configure your agent on the website (mint from X signal or pick template)
2. Your GitHub repo is auto-created on your account
3. Post the pre-filled tweet
4. Grok detects `@grok install`, runs safety scan, deploys natively
5. Grok greets you in the thread with a command menu
6. Your agent lives forever on your X page — `@YourAgent` summons it anywhere

## The promise that will never change

Once your AI agent is spawned on your page, it is **100% yours**. No one — not even us — can control, modify, or use it without your explicit consent. Full ownership, full control, always.

## Universal commands

Every agent ships with these:

| Command | Who | What |
|---|---|---|
| `@AgentName [anything]` | Anyone | Default reply in the agent's voice |
| `@AgentName help` | Anyone | What this agent can do, who built it |
| `@AgentName whatsnew` | Anyone | Pull the latest news/updates from grok-install |
| `@AgentName update` | Owner only | Trigger consent-based update flow |

## Update consent model

Updates are **owner-approved only**. We can't push silent changes — and architecturally we couldn't even if we wanted to.

1. New template versions are published to `manifest.json`
2. Owner sees notification when revisiting the dashboard or via `@MyAgent update`
3. Agent replies *only to verified owner* with the changelog
4. Owner explicitly approves → commit pushed to *their* repo
5. Owner re-tweets `@grok install this` to redeploy

## Safety floor (cannot be loosened)

- Reply-only on mention
- No DMs (without explicit owner approval)
- Clear AI labeling required in bio
- No mass actions
- Honors opt-out immediately
- Rate and cost ceilings declared per agent
- Deepfake-free mascot generation
- No hardcoded keys

Full details: [SAFETY.md](SAFETY.md)

## Architecture

- **Frontend**: static HTML on GitHub Pages — no tracking, no auth to browse
- **Backend**: single Cloudflare Worker — X OAuth, GitHub App, Grok API, KV storage
- **Each agent**: self-contained GitHub repo on the user's account — they own it
- **Runtime**: xAI X-native runtime — we don't host agents

## Quickstart (developers)

Python 3.10+ required. `grok-install` is a **Python CLI** — install it from
PyPI with `pip` or `uv`:

```bash
git clone https://github.com/AgentMindCloud/grok-install
cd grok-install
npm install
node safety-scanner.js templates/DogeDoughAI.yaml
```

To mint your own: visit [agentmindcloud.github.io/grok-install/safe-agent-builder.html](https://agentmindcloud.github.io/grok-install/safe-agent-builder.html).

## Deploying the Worker (maintainers)

The API Worker config lives at `wrangler.toml` at the repo root (the JS source stays in `worker/src/`; `main` in the config points there).

The API Worker auto-deploys to Cloudflare on every push to `main` via Cloudflare Workers Builds (Deploy command: `npx wrangler deploy`). Manual deploys still work:

```bash
npm run worker:deploy # wrangler deploy
npm run worker:dev # local dev server
npm run worker:tail # live log stream
```

## Contributing

PRs welcome. Especially:
- New template agents (small-function, mention-only)
- Translations
- Safety scanner improvements
- New mascot styles

## License

Apache License 2.0. See [LICENSE](LICENSE).

## Credits

Built by [@JanSol0s](https://x.com/JanSol0s). Powered by xAI's `grok-install` standard.

---

*"Once your AI agent is spawned on your page, it is 100% yours."*
132 changes: 8 additions & 124 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,133 +1,17 @@
<div align="center">
# grok-install-legacy — Archived

<img src="assets/spectral-hero.svg" alt="grok-install — Spectral edition" width="100%" />
This repository has been archived as of 2026-05-11.

# grok-install
## Where the work lives now

### *Mint personalized AI agents on X. Safety-first. Owner-consent updates. Open source.*
This repo was renamed from `grok-install` to `grok-install-legacy` during the unified ecosystem redesign. The canonical [grok-install](https://github.com/AgentMindCloud/grok-install) now lives at the same URL the legacy repo previously occupied and represents the v1.0 open standard for Grok agents on X.

[![Built with grok-install](badge.svg)](https://github.com/AgentMindCloud/grok-install)
[![License](https://img.shields.io/badge/license-Apache_2.0-FF1E70?style=flat-square&labelColor=0A0A0A)](LICENSE)
[![Spec](https://img.shields.io/badge/spec-v2.13-00E0D5?style=flat-square&labelColor=0A0A0A)](spec/)
[![Safety](https://img.shields.io/badge/safety-tier_1_floor-FF1E70?style=flat-square&labelColor=0A0A0A)](SAFETY.md)
[![Visual System](https://img.shields.io/badge/visual-spectral-00E0D5?style=flat-square&labelColor=0A0A0A)](DESIGN_SYSTEM.md)
This archive preserves the v0.x history.

</div>
## Why archived

---

**grok-install** is an open-source platform that lets X users mint personalized AI agents from their X profile signal — or pick from a curated template library — and install them natively on X via xAI's `@grok install` standard.

Two paths, same safety floor:

- **Mint from your X signal** — Sign in with X, we analyze your voice and style, you get a one-of-a-kind agent with a unique Genesis ID.
- **Pick a template** — 8 pre-tuned agents covering brand assistant, market signals, creative, dev help, Q&A, daily brief, vibe replies, show notes.

Live demo: [agentmindcloud.github.io/grok-install](https://agentmindcloud.github.io/grok-install/safe-agent-builder.html)

---

## How it works

```
[Configure here] → [Repo created] → [Post on X] → [@grok install] → [Grok greets] → [Lives on your X page]
AUTO AUTO AUTO
```

1. Configure your agent on the website (mint from X signal or pick template)
2. Your GitHub repo is auto-created on your account
3. Post the pre-filled tweet
4. Grok detects `@grok install`, runs safety scan, deploys natively
5. Grok greets you in the thread with a command menu
6. Your agent lives forever on your X page — `@YourAgent` summons it anywhere

## The promise that will never change

Once your AI agent is spawned on your page, it is **100% yours**. No one — not even us — can control, modify, or use it without your explicit consent. Full ownership, full control, always.

## Universal commands

Every agent ships with these:

| Command | Who | What |
|---|---|---|
| `@AgentName [anything]` | Anyone | Default reply in the agent's voice |
| `@AgentName help` | Anyone | What this agent can do, who built it |
| `@AgentName whatsnew` | Anyone | Pull the latest news/updates from grok-install |
| `@AgentName update` | Owner only | Trigger consent-based update flow |

## Update consent model

Updates are **owner-approved only**. We can't push silent changes — and architecturally we couldn't even if we wanted to.

1. New template versions are published to `manifest.json`
2. Owner sees notification when revisiting the dashboard or via `@MyAgent update`
3. Agent replies *only to verified owner* with the changelog
4. Owner explicitly approves → commit pushed to *their* repo
5. Owner re-tweets `@grok install this` to redeploy

## Safety floor (cannot be loosened)

- Reply-only on mention
- No DMs (without explicit owner approval)
- Clear AI labeling required in bio
- No mass actions
- Honors opt-out immediately
- Rate and cost ceilings declared per agent
- Deepfake-free mascot generation
- No hardcoded keys

Full details: [SAFETY.md](SAFETY.md)

## Architecture

- **Frontend**: static HTML on GitHub Pages — no tracking, no auth to browse
- **Backend**: single Cloudflare Worker — X OAuth, GitHub App, Grok API, KV storage
- **Each agent**: self-contained GitHub repo on the user's account — they own it
- **Runtime**: xAI X-native runtime — we don't host agents

## Quickstart (developers)

Python 3.10+ required. `grok-install` is a **Python CLI** — install it from
PyPI with `pip` or `uv`:

```bash
git clone https://github.com/AgentMindCloud/grok-install
cd grok-install
npm install
node safety-scanner.js templates/DogeDoughAI.yaml
```

To mint your own: visit [agentmindcloud.github.io/grok-install/safe-agent-builder.html](https://agentmindcloud.github.io/grok-install/safe-agent-builder.html).

## Deploying the Worker (maintainers)

The API Worker config lives at `wrangler.toml` at the repo root (the JS source stays in `worker/src/`; `main` in the config points there).

The API Worker auto-deploys to Cloudflare on every push to `main` via Cloudflare Workers Builds (Deploy command: `npx wrangler deploy`). Manual deploys still work:

```bash
npm run worker:deploy # wrangler deploy
npm run worker:dev # local dev server
npm run worker:tail # live log stream
```

## Contributing

PRs welcome. Especially:
- New template agents (small-function, mention-only)
- Translations
- Safety scanner improvements
- New mascot styles
Folded into the unified ecosystem. See the [migration plan](https://github.com/AgentMindCloud/ecosystem-redesign/blob/main/PORTFOLIO-MAP.md) for context.

## License

Apache License 2.0. See [LICENSE](LICENSE).

## Credits

Built by [@JanSol0s](https://x.com/JanSol0s). Powered by xAI's `grok-install` standard.

---

*"Once your AI agent is spawned on your page, it is 100% yours."*
Apache 2.0 — original code preserved in this archive under Apache 2.0, continued under Apache 2.0 at the new location.
Loading