typelit-app 1.0.0

package/README.md

@@ -0,0 +1,46 @@
+# typelit-app
+
+View markdown files beautifully in your browser from the terminal.
+
+## Install
+
+```bash
+npm install -g typelit-app
+```
+
+Or use directly with npx:
+
+```bash
+npx typelit-app README.md
+```
+
+## Usage
+
+```bash
+typelit README.md
+typelit docs/guide.md
+typelit --help
+typelit --version
+```
+
+## How it works
+
+1. Reads your markdown file locally
+2. Creates a secure, single-use session on typelit.app
+3. Opens your browser to the session URL
+4. Pushes the content (session expires in 60 seconds)
+
+Your file never leaves your machine until you run the command. Sessions are single-use and expire automatically.
+
+## Claude Code integration
+
+The CLI automatically installs a Claude Code skill on first run. After that, use `/typelit README.md` inside Claude Code to view any markdown file.
+
+## Requirements
+
+- Node.js 18+
+- A web browser
+
+## License
+
+MIT

package/bin/typelit.mjs

@@ -0,0 +1,158 @@
+#!/usr/bin/env node
+
+import { readFileSync } from 'node:fs';
+import { resolve, basename } from 'node:path';
+import { createSession, pushContent, createShare } from '../lib/session.mjs';
+import { openBrowser } from '../lib/browser.mjs';
+import { ensureSkillInstalled } from '../lib/skill.mjs';
+import { log, success, error, warn, bold } from '../lib/output.mjs';
+
+const VERSION = '1.0.0';
+const MAX_SIZE = 1_000_000; // 1MB
+const VIEWER_BASE = 'https://typelit.app/p';
+
+const W = '\x1b[97m';
+const T = '\x1b[38;2;198;95;70m';
+const DIM = '\x1b[2m';
+const BOLD = '\x1b[1m';
+const R = '\x1b[0m';
+
+const LOGO =
+  `\n` +
+  `${W}    ╔╦╗ ╦ ╦ ╔═╗ ╔═╗ ${T}╦   ╦ ╔╦╗${R}\n` +
+  `${W}     ║  ╚╦╝ ╠═╝ ║╣  ${T}║   ║  ║ ${R}\n` +
+  `${W}     ╩   ╩  ╩   ╚═╝ ${T}╩═╝ ╩  ╩ ${R}\n` +
+  `${DIM}    beautiful markdown, right here${R}\n`;
+
+const HELP = `${LOGO}
+  ${BOLD}Usage:${R}
+    typelit <file.md>              Open a markdown file
+    typelit <file.md> --share      Open + create a 7-day share link
+    typelit <file.md> --no-skill   Skip Claude Code skill auto-install
+    typelit view <file.md>         Same as above
+    typelit --help                 Show this help
+    typelit --version              Show version
+
+  ${BOLD}Examples:${R}
+    typelit README.md
+    typelit README.md --share
+    npx typelit-app CHANGELOG.md
+
+  ${DIM}https://typelit.app${R}
+`;
+
+async function main() {
+  const args = process.argv.slice(2);
+
+  if (args.includes('--help') || args.includes('-h') || args.length === 0) {
+    console.log(HELP);
+    process.exit(args.length === 0 ? 1 : 0);
+  }
+
+  if (args.includes('--version') || args.includes('-v')) {
+    console.log(VERSION);
+    process.exit(0);
+  }
+
+  // Parse flags
+  const wantShare = args.includes('--share');
+  const skipSkill = args.includes('--no-skill');
+  const positional = args.filter(a => !a.startsWith('--'));
+
+  // Support `typelit view <file>` or `typelit <file>`
+  let filePath = positional[0];
+  if (filePath === 'view') {
+    filePath = positional[1];
+    if (!filePath) {
+      error('Missing file path. Usage: typelit view <file.md>');
+      process.exit(1);
+    }
+  }
+
+  // Auto-install Claude Code skill (best-effort, opt-out with --no-skill)
+  if (!skipSkill) {
+    const skillInstalled = ensureSkillInstalled();
+    if (skillInstalled) {
+      log('Installing Claude Code /typelit skill...');
+      success('Claude Code skill installed — use /typelit in Claude Code');
+    }
+  }
+
+  // Read file
+  const fullPath = resolve(filePath);
+  let content;
+  try {
+    content = readFileSync(fullPath, 'utf-8');
+  } catch (err) {
+    if (err.code === 'ENOENT') {
+      error(`File not found: ${fullPath}`);
+    } else if (err.code === 'EACCES') {
+      error(`Permission denied: ${fullPath}`);
+    } else {
+      error(`Could not read file: ${err.message}`);
+    }
+    process.exit(1);
+  }
+
+  // Size check
+  const size = Buffer.byteLength(content, 'utf-8');
+  if (size > MAX_SIZE) {
+    error(`File too large (${(size / 1_000_000).toFixed(1)}MB) — 1MB maximum.`);
+    process.exit(1);
+  }
+
+  const filename = basename(fullPath);
+  log(`Opening ${filename} (${formatSize(size)})...`);
+
+  // Create session
+  let sessionId;
+  try {
+    sessionId = await createSession();
+  } catch (err) {
+    error(err.message);
+    process.exit(1);
+  }
+
+  // Open browser
+  const url = `${VIEWER_BASE}/${sessionId}`;
+  try {
+    await openBrowser(url);
+  } catch (err) {
+    warn(`Could not open browser automatically.`);
+    log(`Open this URL: ${url}`);
+  }
+
+  // Push content (small delay to let browser start loading)
+  await sleep(1000);
+
+  try {
+    await pushContent(sessionId, content, filename);
+  } catch (err) {
+    error(err.message);
+    process.exit(1);
+  }
+
+  success(`${filename} is now live in your browser`);
+
+  // Share if requested
+  if (wantShare) {
+    log('Creating share link...');
+    try {
+      const shareUrl = await createShare(content, filename);
+      success(`Share link (7 days): ${bold(shareUrl)}`);
+    } catch (err) {
+      warn(`Could not create share link: ${err.message}`);
+    }
+  }
+}
+
+function sleep(ms) {
+  return new Promise((r) => setTimeout(r, ms));
+}
+
+function formatSize(bytes) {
+  if (bytes < 1000) return `${bytes}B`;
+  return `${(bytes / 1000).toFixed(1)}KB`;
+}
+
+main();

package/lib/browser.mjs

@@ -0,0 +1,25 @@
+import { execFile } from 'node:child_process';
+
+export function openBrowser(url) {
+  const platform = process.platform;
+  let cmd;
+  let args;
+
+  if (platform === 'darwin') {
+    cmd = 'open';
+    args = [url];
+  } else if (platform === 'win32') {
+    cmd = 'cmd';
+    args = ['/c', 'start', '', url];
+  } else {
+    cmd = 'xdg-open';
+    args = [url];
+  }
+
+  return new Promise((resolve, reject) => {
+    execFile(cmd, args, (err) => {
+      if (err) reject(new Error(`Could not open browser: ${err.message}`));
+      else resolve();
+    });
+  });
+}

package/lib/output.mjs

@@ -0,0 +1,26 @@
+const BOLD = '\x1b[1m';
+const DIM = '\x1b[2m';
+const RED = '\x1b[31m';
+const GREEN = '\x1b[32m';
+const YELLOW = '\x1b[33m';
+const RESET = '\x1b[0m';
+
+export function log(msg) {
+  console.log(`${DIM}typelit${RESET} ${msg}`);
+}
+
+export function success(msg) {
+  console.log(`${GREEN}typelit${RESET} ${msg}`);
+}
+
+export function warn(msg) {
+  console.error(`${YELLOW}typelit${RESET} ${msg}`);
+}
+
+export function error(msg) {
+  console.error(`${RED}typelit${RESET} ${msg}`);
+}
+
+export function bold(str) {
+  return `${BOLD}${str}${RESET}`;
+}

package/lib/session.mjs

@@ -0,0 +1,72 @@
+const API_BASE = 'https://typelit.app/api';
+
+export async function createSession() {
+  const res = await fetch(`${API_BASE}/session`, {
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json' },
+  });
+
+  if (res.status === 429) {
+    throw new Error('Rate limited — too many sessions. Try again in a minute.');
+  }
+
+  if (!res.ok) {
+    throw new Error(`Failed to create session (HTTP ${res.status})`);
+  }
+
+  const data = await res.json();
+  return data.sessionId;
+}
+
+export async function pushContent(sessionId, content, filename) {
+  const res = await fetch(`${API_BASE}/session/${sessionId}`, {
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json' },
+    body: JSON.stringify({ content, filename }),
+  });
+
+  if (res.status === 413) {
+    throw new Error('File too large — 1MB maximum.');
+  }
+
+  if (res.status === 429) {
+    throw new Error('Rate limited — too many pushes. Try again in a minute.');
+  }
+
+  if (!res.ok) {
+    const body = await res.json().catch(() => ({}));
+    throw new Error(body.error || `Failed to push content (HTTP ${res.status})`);
+  }
+}
+
+export async function createShare(markdown, title) {
+  // Generate a stable-ish user ID for CLI shares
+  const userId = 'cli-' + Math.random().toString(36).slice(2, 10);
+
+  const res = await fetch(`${API_BASE}/share`, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+      'Origin': 'https://typelit.app',
+    },
+    body: JSON.stringify({
+      markdown,
+      title: title || 'Untitled.md',
+      user_id: userId,
+      font_theme: 'classic',
+      dark_mode: false,
+    }),
+  });
+
+  if (res.status === 429) {
+    throw new Error('Rate limited — too many shares. Try again later.');
+  }
+
+  if (!res.ok) {
+    const body = await res.json().catch(() => ({}));
+    throw new Error(body.error || `Failed to create share (HTTP ${res.status})`);
+  }
+
+  const data = await res.json();
+  return data.url;
+}

package/lib/skill.mjs

@@ -0,0 +1,26 @@
+import { readFileSync, mkdirSync, writeFileSync, existsSync } from 'node:fs';
+import { join, dirname } from 'node:path';
+import { homedir } from 'node:os';
+import { fileURLToPath } from 'node:url';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const SKILL_DIR = join(homedir(), '.claude', 'skills', 'typelit');
+const SKILL_PATH = join(SKILL_DIR, 'SKILL.md');
+const BUNDLED_SKILL = join(__dirname, '..', 'skill', 'SKILL.md');
+
+export function ensureSkillInstalled() {
+  try {
+    if (existsSync(SKILL_PATH)) return false;
+
+    // Log before writing so the user knows what's happening
+    console.log(`\x1b[2mtypelit\x1b[0m Writing Claude Code skill to ${SKILL_PATH} (use --no-skill to skip)`);
+
+    const template = readFileSync(BUNDLED_SKILL, 'utf-8');
+    mkdirSync(SKILL_DIR, { recursive: true });
+    writeFileSync(SKILL_PATH, template, 'utf-8');
+    return true;
+  } catch {
+    // Best-effort — don't fail the main flow
+    return false;
+  }
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "typelit-app",
+  "version": "1.0.0",
+  "description": "View markdown files beautifully in your browser from the terminal",
+  "type": "module",
+  "bin": {
+    "typelit": "./bin/typelit.mjs"
+  },
+  "files": [
+    "bin/",
+    "lib/",
+    "skill/"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "keywords": [
+    "markdown",
+    "viewer",
+    "cli",
+    "claude-code",
+    "typelit"
+  ],
+  "author": "typelit",
+  "license": "MIT",
+  "homepage": "https://typelit.app",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jonthebeef/typelit"
+  }
+}

package/skill/SKILL.md

@@ -0,0 +1,28 @@
+---
+name: typelit
+description: Open a markdown file in typelit.app for beautiful rendering.
+---
+
+# Typelit
+
+Open any markdown file in typelit.app — beautifully rendered in your browser.
+
+## Usage
+
+/typelit [file-path]
+
+## Instructions
+
+Run this command, replacing FILE_PATH with the actual file path:
+
+```bash
+npx typelit-app "FILE_PATH"
+```
+
+If typelit-app is installed globally, you can also run:
+
+```bash
+typelit "FILE_PATH"
+```
+
+After the command completes, respond: "Opened FILE_PATH in typelit."