Documentation
you.md
The identity file for the agent internet. A structured, portable identity bundle that gives every AI agent context about who you are.
Getting Started
you.md creates a persistent identity context that any AI agent can read. Think of it as a .env file for your identity -- your bio, projects, values, communication style, and preferences, all in one place.
Web Quickstart
- 1Go to you.md/create
- 2Pick a username and enter your name
- 3Your profile is created instantly -- no account needed
- 4Sign up at you.md/sign-up to claim ownership
- 5Open the dashboard, type
/shareto get your shareable context link
CLI Quickstart
$ npx youmd init
- 1The agent walks you through creating your identity interactively
- 2Run
youmd loginto connect to you.md - 3Run
youmd pushto publish your profile - 4Run
youmd chatthen type/shareto get your context link
Share Your Identity
The core feature. Once your identity is built, share it with any AI agent in seconds. The /share command works in both the web dashboard and the CLI.
/share Command
Type /share in either the web dashboard terminal or inside youmd chat on the CLI. Both generate the same copyable block:
> /share --- BEGIN YOU.MD CONTEXT --- name: Houston Golden role: Founder & builder projects: you.md, ... values: ship fast, build in public preferences: terminal-native, monochrome --- END YOU.MD CONTEXT --- [copied to clipboard]
Paste this into any AI conversation -- Claude, ChatGPT, Cursor, Copilot, or any agent. It instantly knows your bio, projects, values, and preferences.
Use /share --private to include your private layer (contact info, internal notes, sensitive preferences). Only share this with agents you trust.
Context Links
Your public context is always available at you.md/ctx/[username]. Any agent can fetch this URL directly to load your context into their conversation.
Sync
You.md works across web and CLI. Create your profile on either platform and keep them in sync.
Connecting Web + CLI
- 1Create your profile on either web or CLI
- 2Get an API key from the dashboard (
/tokens) - 3
youmd login -k YOUR_KEYoryoumd login --web - 4
youmd pulldownloads your web profile to local files - 5Edit files in any editor (Cursor, Obsidian, VS Code)
- 6
youmd pushcompiles and publishes back to you.md - 7
youmd sync --watchauto-syncs on every file save
Local File Structure
.youmd/
profile/
about.md
now.md
projects.md
values.md
links.md
preferences/
agent.md
writing.md
voice/
voice.md
voice.linkedin.md
you.json
you.md
manifest.jsonCLI Reference
Install globally with npm i -g youmd or run commands directly with npx youmd.
| Command | Description |
|---|---|
| youmd init | Create your identity bundle (interactive AI onboarding) |
| youmd login | Authenticate (--web to open browser, -k KEY) |
| youmd pull | Download profile from web to local .youmd/ files |
| youmd push | Upload local files to web and publish |
| youmd sync | Pull + push (--watch for auto-sync on file save) |
| youmd chat | Talk to the you agent |
| youmd build | Compile local bundle from profile files |
| youmd publish | Publish compiled bundle to you.md |
| youmd status | Show bundle and pipeline status |
| youmd whoami | Show current authenticated user |
| youmd add TYPE URL | Add a source (website, linkedin, x, blog, github) |
| youmd link | Manage context links (create, list, revoke) |
| youmd keys | Manage API keys (list, create, revoke) |
init command runs a conversational AI onboarding -- it asks about your work, projects, values, and preferences, then builds your identity file automatically.API
You.md exposes HTTP endpoints for programmatic access to identity context.
Public Endpoints
# Fetch a public profile GET /api/v1/profiles?username=houston # Public context (agent-readable, plain text) GET /ctx/[username] # JSON context GET /ctx/[username].json
Context links at /ctx/[username] return a plain-text identity block optimized for AI consumption. Agents can fetch this URL directly.
Authenticated Endpoints
For private context, include an access token:
GET /ctx/[username]?scope=private Authorization: Bearer your_access_token
Privacy
You.md uses a two-layer privacy model:
/share --private or access tokens.Access tokens can be generated from the dashboard via /tokens. Each token has configurable scope and can be revoked at any time.
Dashboard Commands
The web dashboard terminal supports the following slash commands:
| Command | Description |
|---|---|
| /share | Generate shareable identity context block |
| /share --private | Include private layer in context block |
| /preview | Preview your public profile |
| /json | Export identity as raw JSON |
| /settings | Open account settings |
| /tokens | Manage API access tokens |
| /billing | View billing and subscription |
| /status | Check profile completeness and status |
| /publish | Publish latest changes to your public profile |
| /help | Show all available commands |