mdedit-cli
Advanced tools
+36
-1
@@ -80,7 +80,42 @@ { | ||
| "--content <text>": "Inline content string", | ||
| "--publish": "Publish the created article to a public mded.it link", | ||
| "--slug <slug>": "Custom public-link slug (requires --publish)", | ||
| "--yes": "Skip public-publishing confirmation", | ||
| "--workspace <id>": "Workspace ID" | ||
| }, | ||
| "example": "echo '# Hello' | mdedit article create --title 'My Post' --file - --format json" | ||
| "example": "mdedit article create --title 'My Post' --file post.md --publish --yes --format json" | ||
| }, | ||
| { | ||
| "name": "article_publish", | ||
| "description": "Publish or update an article at a public mded.it link. Requires publishing:write.", | ||
| "command": "mdedit article publish <articleId> --yes --format json", | ||
| "flags": { | ||
| "--slug <slug>": "Custom public-link slug", | ||
| "--seo-title <title>": "SEO/social title for the public page", | ||
| "--seo-description <description>": "SEO/social description for the public page", | ||
| "--yes": "Confirm that anyone with the link may view the document", | ||
| "--workspace <id>": "Workspace ID" | ||
| }, | ||
| "example": "mdedit article publish abc123 --slug public-draft --yes --format json" | ||
| }, | ||
| { | ||
| "name": "article_publish_status", | ||
| "description": "Get an article's public-link status, URL, metadata, and view count. Requires publishing:read.", | ||
| "command": "mdedit article publish-status <articleId> --format json", | ||
| "flags": { | ||
| "--workspace <id>": "Workspace ID" | ||
| }, | ||
| "example": "mdedit article publish-status abc123 --format json" | ||
| }, | ||
| { | ||
| "name": "article_unpublish", | ||
| "description": "Disable an article's public link. Requires publishing:write.", | ||
| "command": "mdedit article unpublish <articleId> --yes --format json", | ||
| "flags": { | ||
| "--yes": "Confirm that the public link should stop working", | ||
| "--workspace <id>": "Workspace ID" | ||
| }, | ||
| "example": "mdedit article unpublish abc123 --yes --format json" | ||
| }, | ||
| { | ||
| "name": "article_update", | ||
@@ -87,0 +122,0 @@ "description": "Update an article's title, metadata, or markdown content", |
+3
-3
| { | ||
| "name": "mdedit-cli", | ||
| "version": "0.2.2", | ||
| "version": "0.3.0", | ||
| "private": false, | ||
@@ -42,4 +42,4 @@ "type": "module", | ||
| "dependencies": { | ||
| "@mdedit/agent-client": "0.1.0", | ||
| "@mdedit/sdk": "0.2.2", | ||
| "@mdedit/agent-client": "0.2.0", | ||
| "@mdedit/sdk": "0.3.0", | ||
| "chalk": "^5.6.2", | ||
@@ -46,0 +46,0 @@ "commander": "^14.0.3", |
+26
-0
@@ -58,2 +58,28 @@ # `mdedit-cli` | ||
| ## Public links | ||
| Use a key with `publishing:write` to publish or update a public snapshot. Publishing is | ||
| explicit: later edits stay private until the command is run again. | ||
| ```bash | ||
| mdedit article publish <articleId> --yes | ||
| mdedit article publish <articleId> --slug my-document --yes | ||
| mdedit article publish-status <articleId> --format json | ||
| mdedit article unpublish <articleId> --yes | ||
| ``` | ||
| Create a document from Markdown and publish it in one command: | ||
| ```bash | ||
| mdedit article create \ | ||
| --file document.md \ | ||
| --publish \ | ||
| --yes | ||
| ``` | ||
| Without `--title`, the CLI uses the first Markdown H1 or the filename. | ||
| The JSON result includes `publication.shortUrl`, such as | ||
| `https://mded.it/my-document`. If article creation succeeds but publishing fails, the | ||
| article is kept private and the command reports its article ID. | ||
| ## Review commands | ||
@@ -60,0 +86,0 @@ |
+8
-0
@@ -97,2 +97,3 @@ # mdedit CLI — Agent Skill | ||
| echo "# Hello" | mdedit article create --title "My Article" --file - | ||
| mdedit article create --file article.md --publish --yes | ||
@@ -115,2 +116,8 @@ # Update | ||
| # Publish a deliberate public snapshot (requires publishing:write) | ||
| mdedit article publish <articleId> --yes | ||
| mdedit article publish <articleId> --slug my-document --yes | ||
| mdedit article publish-status <articleId> --format json | ||
| mdedit article unpublish <articleId> --yes | ||
| # Delete | ||
@@ -156,2 +163,3 @@ mdedit article delete <articleId> --yes | ||
| mdedit apikey create --name "CI/CD Key" --description "Used in pipeline" --scopes articles:read,articles:write | ||
| mdedit apikey create --name "Publishing agent" --scopes articles:read,articles:write,publishing:write | ||
| mdedit apikey create --name "30-day key" --expires 30 | ||
@@ -158,0 +166,0 @@ mdedit apikey revoke <keyId> --yes |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
357298
14.29%2757
9.14%154
20.31%+ Added
+ Added
- Removed
- Removed
Updated
Updated