@vantienkhai/shippage-cli 0.1.0 → 0.1.1

package/README.md

@@ -2,15 +2,36 @@
 
 Publish HTML, Markdown, and text files into Shippage from AI agents or scripts.
 
+## Install
+
 ```bash
-export SHIPPAGE_API_URL=http://localhost:3000
-export SHIPPAGE_TOKEN=<supabase-access-token>
+npm i -g @vantienkhai/shippage-cli
+```
+
+## Authenticate
 
-shippage publish ./out/article.html --title "AI Search Glossary" --visibility unlisted --noindex
-shippage bulk "out/**/*.html" --visibility unlisted --noindex
+Sign in to Shippage and open the **Dashboard → CLI access** panel to copy your
+API URL and create a long-lived API key, then export them:
+
+```bash
+export SHIPPAGE_API_URL="https://shippage.vantienkhai-uet.workers.dev"
+export SHIPPAGE_TOKEN="<your spg_ API key>"
+```
+
+> API key secrets are shown only once. Store them securely and revoke unused
+> keys from the dashboard.
+
+## Commands
+
+```bash
+shippage publish ./out/article.html --title "AI Search Glossary" --slug ai-search-glossary --visibility public
+shippage bulk "out/**/*.html" --visibility unlisted
 shippage list
 shippage share abc123 --visibility private --private-token
 shippage domain add docs.example.com
+shippage domain verify docs.example.com
 ```
 
 For anonymous publishing, omit `SHIPPAGE_TOKEN`. Anonymous pages are ownerless until a later claim flow is added.
+
+Visibility controls search behavior automatically: `public` pages are indexable; `unlisted` and `private` pages are `noindex`.

package/dist/index.js

@@ -58,21 +58,20 @@ async function publishFile(filePath, options) {
   if (options.slug) form.set("slug", options.slug);
   if (options.domain) form.set("domain", options.domain);
   if (options.visibility) form.set("visibility", options.visibility);
-  if (options.noindex) form.set("noindex", "true");
   return requestJson("/api/upload", {
     method: "POST",
     body: form
   });
 }
 program.name("shippage").description("CLI for Shippage fast HTML publishing").version("0.1.0");
-program.command("login").description("Print shell export instructions for API auth").option("--token <token>", "Supabase access token").option("--api-url <url>", "Shippage API URL").action((options) => {
+program.command("login").description("Print shell export instructions for API auth").option("--token <token>", "Shippage API key").option("--api-url <url>", "Shippage API URL").action((options) => {
   if (options.apiUrl) console.log(`export SHIPPAGE_API_URL=${JSON.stringify(options.apiUrl)}`);
   if (options.token) console.log(`export SHIPPAGE_TOKEN=${JSON.stringify(options.token)}`);
   if (!options.apiUrl && !options.token) {
     console.log("Set SHIPPAGE_API_URL and SHIPPAGE_TOKEN in your shell or .env file.");
   }
 });
-program.command("publish").argument("<file>", "HTML, Markdown, or text file").option("--title <title>", "Page title").option("--description <description>", "Page meta description").option("--slug <slug>", "Custom path slug").option("--domain <domain>", "Verified custom domain").option("--visibility <visibility>", "public, unlisted, or private", "unlisted").option("--noindex", "Keep robots noindex").action(async (file, options) => {
+program.command("publish").argument("<file>", "HTML, Markdown, or text file").option("--title <title>", "Page title").option("--description <description>", "Page meta description").option("--slug <slug>", "Custom path slug").option("--domain <domain>", "Verified custom domain").option("--visibility <visibility>", "public, unlisted, or private", "unlisted").action(async (file, options) => {
   const result = await publishFile(file, options);
   console.log(chalk.green("Published"));
   console.log(`${result.title}: ${result.shareUrl}`);
@@ -80,7 +79,7 @@ program.command("publish").argument("<file>", "HTML, Markdown, or text file").op
     console.log(`Custom URL: ${result.customUrl}`);
   }
 });
-program.command("bulk").argument("<pattern>", "Glob pattern, for example out/**/*.html").option("--visibility <visibility>", "public, unlisted, or private", "unlisted").option("--noindex", "Keep robots noindex").action(async (pattern, options) => {
+program.command("bulk").argument("<pattern>", "Glob pattern, for example out/**/*.html").option("--visibility <visibility>", "public, unlisted, or private", "unlisted").action(async (pattern, options) => {
   const files = await globby(pattern, { onlyFiles: true });
   if (!files.length) {
     console.log(chalk.yellow("No files matched."));
@@ -99,13 +98,12 @@ program.command("list").description("List pages owned by the current token").act
     console.log(`${page.share_id}	${page.visibility}	${page.noindex ? "noindex" : "index"}	${page.canonical_path}	${page.title}`);
   }
 });
-program.command("share").argument("<shareId>", "Page share id").option("--visibility <visibility>", "public, unlisted, or private").option("--index", "Allow indexing").option("--noindex", "Keep robots noindex").option("--private-token", "Generate a private token").option("--domain <domain>", "Attach to a verified custom domain").option("--slug <slug>", "Custom path slug on the domain").action(async (shareId, options) => {
+program.command("share").argument("<shareId>", "Page share id").option("--visibility <visibility>", "public, unlisted, or private").option("--private-token", "Generate a private token").option("--domain <domain>", "Attach to a verified custom domain").option("--slug <slug>", "Custom path slug on the domain").action(async (shareId, options) => {
   const payload = await requestJson(`/api/pages/${shareId}`, {
     method: "PATCH",
     headers: { "content-type": "application/json" },
     body: JSON.stringify({
       visibility: options.visibility,
-      noindex: options.index ? false : options.noindex ? true : void 0,
       privateToken: options.privateToken,
       domain: options.domain,
       slug: options.slug

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vantienkhai/shippage-cli",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Publish HTML, Markdown, and text files to Shippage from AI agents or scripts.",
   "license": "MIT",
   "type": "module",