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.

No account required to start. Pick a username, build your profile, and sign up later to claim ownership.

Web Quickstart

  1. 1Go to you.md/create
  2. 2Pick a username and enter your name
  3. 3Your profile is created instantly -- no account needed
  4. 4Sign up at you.md/sign-up to claim ownership
  5. 5Open the dashboard, type /share to get your shareable context link

CLI Quickstart

terminal
$ npx youmd init
  1. 1The agent walks you through creating your identity interactively
  2. 2Run youmd login to connect to you.md
  3. 3Run youmd push to publish your profile
  4. 4Run youmd chat then type /share to 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:

output
> /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.

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

  1. 1Create your profile on either web or CLI
  2. 2Get an API key from the dashboard (/tokens)
  3. 3youmd login -k YOUR_KEY or youmd login --web
  4. 4youmd pull downloads your web profile to local files
  5. 5Edit files in any editor (Cursor, Obsidian, VS Code)
  6. 6youmd push compiles and publishes back to you.md
  7. 7youmd sync --watch auto-syncs on every file save

Local File Structure

.youmd/
.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.json

CLI Reference

Install globally with npm i -g youmd or run commands directly with npx youmd.

CommandDescription
youmd initCreate your identity bundle (interactive AI onboarding)
youmd loginAuthenticate (--web to open browser, -k KEY)
youmd pullDownload profile from web to local .youmd/ files
youmd pushUpload local files to web and publish
youmd syncPull + push (--watch for auto-sync on file save)
youmd chatTalk to the you agent
youmd buildCompile local bundle from profile files
youmd publishPublish compiled bundle to you.md
youmd statusShow bundle and pipeline status
youmd whoamiShow current authenticated user
youmd add TYPE URLAdd a source (website, linkedin, x, blog, github)
youmd linkManage context links (create, list, revoke)
youmd keysManage API keys (list, create, revoke)
The 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

HTTP
# 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:

HTTP
GET /ctx/[username]?scope=private
Authorization: Bearer your_access_token

Privacy

You.md uses a two-layer privacy model:

publicYour bio, role, projects, values, and communication style. Visible to anyone and any agent.
privateContact info, internal notes, sensitive preferences, API keys. Only shared via /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.

You control what goes into each layer. Nothing is shared without your explicit action.

Dashboard Commands

The web dashboard terminal supports the following slash commands:

CommandDescription
/shareGenerate shareable identity context block
/share --privateInclude private layer in context block
/previewPreview your public profile
/jsonExport identity as raw JSON
/settingsOpen account settings
/tokensManage API access tokens
/billingView billing and subscription
/statusCheck profile completeness and status
/publishPublish latest changes to your public profile
/helpShow all available commands
you.md -- the identity file for the agent internetGet Started