@mejazbese21/obsidian-clipper-cli 1.6.3 → 1.6.4

package/README.md

@@ -17,6 +17,70 @@ Install the extension by downloading it from the official directory for your bro
 
 Documentation is available on the [Obsidian Help site](https://help.obsidian.md/web-clipper), which covers how to use [highlighting](https://help.obsidian.md/web-clipper/highlight), [templates](https://help.obsidian.md/web-clipper/templates), [variables](https://help.obsidian.md/web-clipper/variables), [filters](https://help.obsidian.md/web-clipper/filters), and more.
 
+## Command-line interface (CLI)
+
+The same clipping engine is also available as a command-line tool. Give it a URL and a template, and it fetches the page, extracts the main content, converts it to Markdown, and prints an Obsidian-ready note — identical to what the browser extension produces.
+
+### Install
+
+```
+npm install -g @mejazbese21/obsidian-clipper-cli
+```
+
+Or run it without installing:
+
+```
+npx @mejazbese21/obsidian-clipper-cli <url> -t template.json
+```
+
+### Quick start
+
+```
+obsidian-clipper https://example.com/article -t template.json
+```
+
+A ready-to-use default **Clippings** template ships as [`template.json`](/template.json). Copy it, tweak the properties, and point `-t` at your own file. Run `obsidian-clipper --help` at any time for the full guide.
+
+### Common uses
+
+```
+# Save to a file instead of printing
+obsidian-clipper https://example.com/article -t template.json -o note.md
+
+# Clip HTML you already saved (no network request); use "-" for stdin
+obsidian-clipper https://example.com/article -t template.json --html page.html
+
+# Send the note straight into an Obsidian vault
+obsidian-clipper https://example.com/article -t template.json --open --vault "My Vault"
+
+# Auto-match a template from a folder, by the URL it triggers on
+obsidian-clipper https://example.com/article -t ./templates/
+```
+
+### Options
+
+| Option | Description |
+| --- | --- |
+| `-t, --template <path>` | Template JSON file, or a directory of templates (required). A directory auto-matches by URL triggers. |
+| `-o, --output <path>` | Write the note to this `.md` file (default: stdout). |
+| `--html <path>` | Use HTML from a file instead of fetching the URL (`-` reads stdin). |
+| `--vault <name>` | Obsidian vault name (with `--open`). |
+| `--open` | Send the note to Obsidian instead of printing it. |
+| `--uri` | With `--open`, use the `obsidian://` URI scheme. |
+| `--silent` | With `--uri`, don't steal focus from the terminal. |
+| `--property-types <path>` | JSON mapping property names to types (`text`, `multitext`, `number`, `checkbox`, `date`, `datetime`). |
+| `-h, --help` | Show the full usage guide. |
+
+Templates, variables, and filters work exactly as they do in the extension — see the [templates](https://help.obsidian.md/web-clipper/templates), [variables](https://help.obsidian.md/web-clipper/variables), and [filters](https://help.obsidian.md/web-clipper/filters) docs.
+
+### Build the CLI from source
+
+```
+npm run build:cli
+```
+
+This bundles the CLI to `dist/cli.cjs`.
+
 ## Contribute
 
 ### Translations

package/dist/cli.cjs

@@ -26398,24 +26398,72 @@ var fs = __toESM(require("fs"));
 var path = __toESM(require("path"));
 function printUsage() {
   const usage = `
-Usage: obsidian-clipper <url> [options]
+obsidian-clipper \u2014 clip a web page into an Obsidian-ready Markdown note.
 
-Options:
-  -t, --template <path>        Path to template JSON file or directory (required)
-                               If a directory, auto-matches template by URL triggers
-  -o, --output <path>          Output .md file path (default: stdout)
-      --html <path>            Read HTML from file instead of fetching URL (use - for stdin)
-      --vault <name>           Obsidian vault name
-      --open                   Send to Obsidian instead of writing file
-      --uri                    Use URI scheme instead of Obsidian CLI
-      --silent                 Suppress Obsidian focus (URI mode)
-      --property-types <path>  JSON mapping property names to types
-  -h, --help                   Show this help message
+Fetches a URL (or reads saved HTML), extracts the main content, converts it to
+Markdown, and applies a template to produce a note with YAML frontmatter \u2014 the
+same output as the Obsidian Web Clipper browser extension.
+
+USAGE
+  obsidian-clipper <url> -t <template> [options]
+
+ARGUMENTS
+  <url>                        The page to clip (e.g. https://example.com/article)
+
+OPTIONS
+  -t, --template <path>        Template JSON file, or a directory of templates
+                               (required). With a directory, the template whose
+                               triggers match <url> is selected automatically.
+  -o, --output <path>          Write the note to this .md file (default: stdout)
+      --html <path>            Use HTML from a file instead of fetching <url>
+                               (use "-" to read HTML from stdin)
+      --vault <name>           Obsidian vault name (used with --open)
+      --open                   Send the note to Obsidian instead of printing it
+      --uri                    With --open, use the obsidian:// URI scheme
+      --silent                 With --uri, don't steal focus from your terminal
+      --property-types <path>  JSON object mapping property names to types
+                               (text | multitext | number | checkbox | date | datetime)
+  -h, --help                   Show this help
+
+EXAMPLES
+  # Print a clipped note to the terminal
+  obsidian-clipper https://example.com/article -t template.json
+
+  # Save the note to a file
+  obsidian-clipper https://example.com/article -t template.json -o note.md
+
+  # Clip HTML you already saved (no network request)
+  obsidian-clipper https://example.com/article -t template.json --html page.html
+
+  # Pipe HTML in from another command
+  curl -sL https://example.com/article | obsidian-clipper https://example.com/article -t template.json --html -
+
+  # Send straight into an Obsidian vault
+  obsidian-clipper https://example.com/article -t template.json --open --vault "My Vault"
+
+  # Let a folder of templates auto-match by URL
+  obsidian-clipper https://example.com/article -t ./templates/
+
+TEMPLATES
+  A template is a JSON file describing the note: its name, save path, body
+  format, and frontmatter properties. Values use {{variables}} (e.g. {{title}},
+  {{content}}, {{url}}, {{date}}) and |filters (e.g. {{author|split:", "}}).
+  A ready-to-use default "Clippings" template ships as template.json \u2014 copy and
+  edit it to make your own.
+
+LEARN MORE
+  Templates:  https://help.obsidian.md/web-clipper/templates
+  Variables:  https://help.obsidian.md/web-clipper/variables
+  Filters:    https://help.obsidian.md/web-clipper/filters
 `.trim();
   console.log(usage);
 }
 function parseArgs(argv) {
   const args = argv.slice(2);
+  if (args.length === 0) {
+    printUsage();
+    process.exit(0);
+  }
   let url = "";
   let templatePath = "";
   let outputPath;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@mejazbese21/obsidian-clipper-cli",
-	"version": "1.6.3",
+	"version": "1.6.4",
 	"description": "Command-line web clipper that turns web pages into Obsidian markdown notes, based on the official Obsidian Web Clipper.",
 	"bin": {
 		"obsidian-clipper": "./dist/cli.cjs"