Skip to content
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
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,22 @@ openscreen export demo.openscreen -o demo.mp4 --json

See the [CLI reference](https://getopenscreen.com/docs/cli/).

### Let your coding agent make the demo

Give Claude Code, Codex or Cursor OpenScreen's MCP tools, and the skill that
teaches the whole job:

```bash
claude mcp add openscreen -- "/Applications/Openscreen.app/Contents/MacOS/Openscreen" mcp
npx skills add getopenscreen/openscreen --skill openscreen-demo
```

Then ask: *"Make a demo video of this feature with OpenScreen."* The agent plans
the storyboard, records the app, edits the take with OpenScreen's own editing
tools, exports the MP4, checks it frame by frame, and drafts the post for X,
which it publishes only once you say yes. The executable on Windows and Linux,
and the other clients, are in [AI editing](https://getopenscreen.com/docs/ai-editing/#letting-an-agent-make-the-whole-video).

## Installation

Every platform has a recommended route below. On Windows that is the Microsoft Store; everywhere else it is the installer from the [GitHub Releases](https://github.com/getopenscreen/openscreen/releases) page.
Expand Down
5 changes: 5 additions & 0 deletions electron/ai-edition/document-service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,11 @@ export class DocumentService {
return path.join(this.projectsRoot, `${safe}${PROJECT_FILE_EXTENSION}`);
}

/** The project's own file, for a reader that takes a path (the export runner). */
filePathFor(projectId: string): string {
return this.fileFor(projectId);
}

private legacyFileFor(projectId: string): string {
const safe = safeProjectId(projectId);
return path.join(this.projectsRoot, `${safe}${LEGACY_PROJECT_FILE_EXTENSION}`);
Expand Down
5 changes: 5 additions & 0 deletions electron/cli/args.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,11 @@ describe("parseCliArgs", () => {
});
});

it("parses mcp, which takes no argument", () => {
expect(parse(["mcp"])).toEqual({ kind: "mcp" });
expect(parse(["mcp", "--port", "1"])).toMatchObject({ kind: "error" });
});

it("parses info and help", () => {
expect(parse(["info", "demo.openscreen", "--json"])).toMatchObject({
kind: "info",
Expand Down
12 changes: 12 additions & 0 deletions electron/cli/args.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,16 @@ export interface CliErrorCommand {
message: string;
}

/** Serve the MCP tools on stdin/stdout, to the agent that started this process. */
export interface CliMcpCommand {
kind: "mcp";
}

export type CliCommand = (
| CliRequest
| CliInfoCommand
| CliPackCommand
| CliMcpCommand
| CliHelpCommand
| CliErrorCommand
) & {
Expand Down Expand Up @@ -60,6 +66,7 @@ const SUBCOMMANDS = new Set([
"pack",
"captions",
"info",
"mcp",
"help",
"--help",
"-h",
Expand All @@ -75,6 +82,7 @@ Usage:
openscreen captions <project.openscreen> Add auto-captions (on-device Whisper) to a project
[--min-words <1-12>] [--max-words <1-12>]
openscreen info <project.openscreen> [--json] Inspect a project file
openscreen mcp Serve the agent tools over MCP on stdio
openscreen help Show this help

Export options:
Expand Down Expand Up @@ -165,6 +173,10 @@ export function parseCliArgs(
if (sub === "sources") return parseSources(args.slice(1), cwd);
if (sub === "pack") return parsePack(args.slice(1), cwd);
if (sub === "captions") return parseCaptions(args.slice(1), cwd);
if (sub === "mcp") {
if (args.length > 1) throw new Error(`Unexpected argument for mcp: ${args[1]}`);
return { kind: "mcp" };
}
return parseInfo(args.slice(1), cwd);
} catch (error) {
return { kind: "error", message: error instanceof Error ? error.message : String(error) };
Expand Down
Loading
Loading