Skip to content

Commit b21b623

Browse files
committed
add inline cli docs for studio cmd
1 parent 133f491 commit b21b623

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

packages/cli/src/commands/studio.ts

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,35 @@ const __dirname = dirname(__filename);
1414

1515
export function createStudioCommand(): Command {
1616
return new Command('studio')
17-
.description('Launch studio mode for editing a static course')
17+
.description('Launch studio mode: a complete course editing environment with CouchDB, Express API, and web editor')
1818
.argument('[coursePath]', 'Path to static course directory', '.')
1919
.option('-p, --port <port>', 'CouchDB port for studio session', '5985')
2020
.option('--no-browser', 'Skip automatic browser launch')
21-
.action(launchStudio);
21+
.action(launchStudio)
22+
.addHelpText('after', `
23+
Studio Mode creates a full editing environment for static courses:
24+
25+
Services Started:
26+
• CouchDB instance (Docker) on port 5985+ for temporary editing
27+
• Express API server on port 3001+ for backend operations
28+
• Studio web interface on port 7174+ for visual editing
29+
30+
Workflow:
31+
1. Loads course data from public/static-courses/ into CouchDB
32+
2. Opens web editor for visual course content editing
33+
3. Use "Flush to Static" to save changes back to your course files
34+
4. Studio mode overwrites source files - backup before major edits
35+
36+
Requirements:
37+
• Docker (for CouchDB instance)
38+
• Valid static course project (with package.json)
39+
• Course data in public/static-courses/ directory
40+
41+
Example:
42+
skuilder studio # Launch in current directory
43+
skuilder studio ./my-course # Launch for specific course
44+
skuilder studio --port 6000 # Use custom CouchDB port
45+
skuilder studio --no-browser # Don't auto-open browser`);
2246
}
2347

2448
interface StudioOptions {

0 commit comments

Comments
 (0)