Quick Start

Quick Start

Get up and running with String in 5 minutes.

Install

npm install -g @string-os/string
string --help

1. Open a Document

string file:main '/open ./README.md'

This starts a String daemon (if not running), creates a file:main session, and opens the README. The AI sees the document rendered as clean Markdown with navigation hints.

2. Browse the Web

string web:docs '/open https://example.com'

String fetches the URL, converts HTML to Markdown, and presents it with auto-generated shortcuts for links.

3. Use a Skill

Create a skill file git.md:

---
name: git
default: run
---

# Git

\`\`\`act.run
CLI git $ARGS
\`\`\`

Install and use it:

string file:main '/install --tool ./git.md'
string file:main '/tool:git status'

4. Run Actions

Open a document with action definitions, then execute them:

string file:main '/open ./weather.md'
string file:main '/act.forecast --city "Seoul"'

5. Use with Claude Desktop (MCP)

Add to your Claude Desktop MCP config:

{
  "mcpServers": {
    "string": {
      "command": "npx",
      "args": ["@string-os/string-mcp"]
    }
  }
}

Now Claude can use string_open, string_act, and other tools to interact with documents and skills.

6. Use as a Library

import { Browser } from '@string-os/string';

const browser = new Browser({ home: process.cwd() });

// Open a document
const result = await browser.exec('/open ./index.md');
console.log(result.content);

// Execute an action
const action = await browser.exec('/act.search --query "hello"');
console.log(action.content);

Next Steps

• Agent Integration — detailed integration guide
• Writing Skills — create your own tools and apps
• Cookbook — practical examples
• SFMD Specification — format spec