@mejazbese21/obsidian-clipper-cli 1.6.5 → 1.6.6

package/README.md

@@ -1,173 +1,116 @@
-Obsidian Web Clipper helps you highlight and capture the web in your favorite browser. Anything you save is stored as durable Markdown files that you can read offline, and preserve for the long term.
+# Obsidian Web Clipper CLI
 
-- **[Download Web Clipper](https://obsidian.md/clipper)**
-- **[Documentation](https://help.obsidian.md/web-clipper)**
-- **[Troubleshooting](https://help.obsidian.md/web-clipper/troubleshoot)**
+Clip web pages to Obsidian-ready Markdown from terminal.
 
-## Get started
+## Install
 
-Install the extension by downloading it from the official directory for your browser:
+```bash
+npm install -g @mejazbese21/obsidian-clipper-cli
+```
 
-- **[Chrome Web Store](https://chromewebstore.google.com/detail/obsidian-web-clipper/cnjifjpddelmedmihgijeibhnjfabmlf)** for Chrome, Brave, Arc, Orion, and other Chromium-based browsers.
-- **[Firefox Add-Ons](https://addons.mozilla.org/en-US/firefox/addon/web-clipper-obsidian/)** for Firefox and Firefox Mobile.
-- **[Safari Extensions](https://apps.apple.com/us/app/obsidian-web-clipper/id6720708363)** for macOS, iOS, and iPadOS.
-- **[Edge Add-Ons](https://microsoftedge.microsoft.com/addons/detail/obsidian-web-clipper/eigdjhmgnaaeaonimdklocfekkaanfme)** for Microsoft Edge.
+## Usage
 
-## Use the extension
+```bash
+obsidian-clipper <url>
+```
 
-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.
+Example:
 
-## Command-line interface (CLI)
+```bash
+obsidian-clipper https://docs.equalsmoney.com/
+```
 
-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.
+Default template used if no template given.
 
-### Install
+## Custom template
 
-```
-npm install -g @mejazbese21/obsidian-clipper-cli
+```bash
+obsidian-clipper https://example.com/article -t template.json
 ```
 
-Or run it without installing:
+## Save to file
 
-```
-npx @mejazbese21/obsidian-clipper-cli <url> -t template.json
+```bash
+obsidian-clipper https://example.com/article -o note.md
 ```
 
-### Quick start
+## Use saved HTML
 
+```bash
+obsidian-clipper https://example.com/article --html page.html
 ```
-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
+Use stdin:
 
+```bash
+cat page.html | obsidian-clipper https://example.com/article --html -
 ```
-# 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
+## Open in Obsidian
 
-# Send the note straight into an Obsidian vault
-obsidian-clipper https://example.com/article -t template.json --open --vault "My Vault"
+```bash
+obsidian-clipper https://example.com/article --open --vault "My Vault"
+```
 
-# Auto-match a template from a folder, by the URL it triggers on
+## Template folder auto-match
+
+```bash
 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. |
+## Options
 
-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.
+| Option             | Use                   |
+| ------------------ | --------------------- |
+| `-t, --template`   | template file/folder  |
+| `-o, --output`     | save markdown file    |
+| `--html`           | use local HTML        |
+| `--vault`          | Obsidian vault name   |
+| `--open`           | send to Obsidian      |
+| `--uri`            | use obsidian:// URI   |
+| `--silent`         | don’t focus Obsidian  |
+| `--property-types` | property type mapping |
+| `-h, --help`       | help                  |
 
-### Build the CLI from source
+## Build
 
-```
+```bash
 npm run build:cli
 ```
 
-This bundles the CLI to `dist/cli.cjs`.
-
-## Contribute
-
-### Translations
-
-You can help translate Web Clipper into your language. Submit your translation via pull request using the format found in the [/_locales](/src/_locales) folder.
+Output:
 
-### Features and bug fixes
-
-See the [help wanted](https://github.com/obsidianmd/obsidian-clipper/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) tag for issues where contributions are welcome.
-
-## Roadmap
-
-In no particular order:
-
-- [ ] Annotate highlights
-- [ ] Template directory
-- [ ] Sync settings across browsers
-- [x] A separate icon for Web Clipper (1.6.3)
-- [x] Template validation (1.1.0)
-- [x] Template logic (if/for)  (1.1.0)
-- [x] Save images locally ([Obsidian 1.8.0](https://obsidian.md/changelog/2024-12-18-desktop-v1.8.0/))
-- [x] Translate UI into more languages — help is welcomed
+```bash
+dist/cli.cjs
+```
 
-## Developers
+## Dev
 
-To build the extension:
+Build extension:
 
-```
+```bash
 npm run build
 ```
 
-This will create three directories:
-- `dist/` for the Chromium version
-- `dist_firefox/` for the Firefox version
-- `dist_safari/` for the Safari version
-
-### Install the extension locally
-
-For Chromium browsers, such as Chrome, Brave, Edge, and Arc:
-
-1. Open your browser and navigate to `chrome://extensions`
-2. Enable **Developer mode**
-3. Click **Load unpacked** and select the `dist` directory
+Run tests:
 
-For Firefox:
-
-1. Open Firefox and navigate to `about:debugging#/runtime/this-firefox`
-2. Click **Load Temporary Add-on**
-3. Navigate to the `dist_firefox` directory and select the `manifest.json` file
-
-If you want to run the extension permanently you can do so with the Nightly or Developer versions of Firefox.
-
-1. Type `about:config` in the URL bar
-2. In the Search box type `xpinstall.signatures.required`
-3. Double-click the preference, or right-click and select "Toggle", to set it to `false`.
-4. Go to `about:addons` > gear icon > **Install Add-on From File…**
-
-For iOS Simulator testing on macOS:
-
-1. Run `npm run build` to build the extension
-2. Open `xcode/Obsidian Web Clipper/Obsidian Web Clipper.xcodeproj` in Xcode
-3. Select the **Obsidian Web Clipper (iOS)** scheme from the scheme selector
-4. Choose an iOS Simulator device and click **Run** to build and launch the app
-5. Once the app is running on the simulator, open **Safari**
-6. Navigate to a webpage and tap the **Extensions** button in Safari to access the Web Clipper extension
-
-### Run tests
-
-```
+```bash
 npm test
 ```
 
-Or run in watch mode during development:
+Watch tests:
 
-```
+```bash
 npm run test:watch
 ```
 
-## Third-party libraries
+## Links
 
-- [webextension-polyfill](https://github.com/mozilla/webextension-polyfill) for browser compatibility
-- [defuddle](https://github.com/kepano/defuddle) for content extraction and Markdown conversion
-- [dayjs](https://github.com/iamkun/dayjs) for date parsing and formatting
-- [lz-string](https://github.com/pieroxy/lz-string) to compress templates to reduce storage space
-- [lucide](https://github.com/lucide-icons/lucide) for icons
-- [dompurify](https://github.com/cure53/DOMPurify) for sanitizing HTML
+* GitHub: https://github.com/mohsingdp-ai/obsidian-clipper-cli
+* Download: https://obsidian.md/clipper
+* Docs: https://help.obsidian.md/web-clipper
+* Troubleshoot: https://help.obsidian.md/web-clipper/troubleshoot
 
 ## License
 
-Obsidian Web Clipper source code is open source under the MIT License. All trademarks, icons, marketing copy, and other marketing assets are excluded from that license.
+MIT, except Obsidian trademarks/icons/marketing assets.

package/dist/cli.cjs

@@ -26405,15 +26405,16 @@ Markdown, and applies a template to produce a note with YAML frontmatter \u2014
 same output as the Obsidian Web Clipper browser extension.
 
 USAGE
-  obsidian-clipper <url> -t <template> [options]
+  obsidian-clipper <url> [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.
+  -t, --template <path>        Template JSON file, or a directory of templates.
+                               Optional \u2014 when omitted, a built-in "Clippings"
+                               template is used. 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)
@@ -26426,7 +26427,10 @@ OPTIONS
   -h, --help                   Show this help
 
 EXAMPLES
-  # Print a clipped note to the terminal
+  # Print a clipped note using the built-in default template
+  obsidian-clipper https://example.com/article
+
+  # Print a clipped note with your own template
   obsidian-clipper https://example.com/article -t template.json
 
   # Save the note to a file
@@ -26542,13 +26546,26 @@ function parseArgs(argv) {
     printUsage();
     process.exit(1);
   }
-  if (!templatePath) {
-    console.error("Error: --template is required");
-    printUsage();
-    process.exit(1);
-  }
-  return { url, templatePath, outputPath, vault, open, silent, uri, propertyTypesPath, htmlPath };
+  return { url, templatePath: templatePath || void 0, outputPath, vault, open, silent, uri, propertyTypesPath, htmlPath };
 }
+var DEFAULT_TEMPLATE = {
+  schemaVersion: "0.1.0",
+  name: "Default",
+  behavior: "create",
+  noteNameFormat: "{{title}}",
+  path: "Clippings",
+  noteContentFormat: "{{content}}",
+  properties: [
+    { name: "title", value: "{{title}}", type: "text" },
+    { name: "source", value: "{{url}}", type: "text" },
+    { name: "author", value: '{{author|split:", "|wikilink|join}}', type: "multitext" },
+    { name: "published", value: "{{published}}", type: "date" },
+    { name: "created", value: "{{date}}", type: "date" },
+    { name: "description", value: "{{description}}", type: "text" },
+    { name: "tags", value: "clippings", type: "multitext" }
+  ],
+  triggers: []
+};
 var templateFilePaths = /* @__PURE__ */ new Map();
 function loadTemplatesFromDir(dirPath) {
   const resolved = path.resolve(dirPath);
@@ -26567,19 +26584,23 @@ var linkedomParser = {
 };
 async function main() {
   const args = parseArgs(process.argv);
-  const resolvedTemplatePath = path.resolve(args.templatePath);
-  const isDir = fs.statSync(resolvedTemplatePath).isDirectory();
   let templates;
   let template2;
-  if (isDir) {
-    templates = loadTemplatesFromDir(resolvedTemplatePath);
-    if (templates.length === 0) {
-      console.error(`Error: No .json template files found in ${args.templatePath}`);
-      process.exit(1);
-    }
+  if (!args.templatePath) {
+    template2 = DEFAULT_TEMPLATE;
   } else {
-    const templateRaw = fs.readFileSync(resolvedTemplatePath, "utf-8");
-    template2 = JSON.parse(templateRaw);
+    const resolvedTemplatePath = path.resolve(args.templatePath);
+    const isDir = fs.statSync(resolvedTemplatePath).isDirectory();
+    if (isDir) {
+      templates = loadTemplatesFromDir(resolvedTemplatePath);
+      if (templates.length === 0) {
+        console.error(`Error: No .json template files found in ${args.templatePath}`);
+        process.exit(1);
+      }
+    } else {
+      const templateRaw = fs.readFileSync(resolvedTemplatePath, "utf-8");
+      template2 = JSON.parse(templateRaw);
+    }
   }
   let propertyTypes;
   if (args.propertyTypesPath) {

package/package.json

@@ -1,7 +1,15 @@
 {
 	"name": "@mejazbese21/obsidian-clipper-cli",
-	"version": "1.6.5",
+	"version": "1.6.6",
 	"description": "Command-line web clipper that turns web pages into Obsidian markdown notes, based on the official Obsidian Web Clipper.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/mohsingdp-ai/obsidian-clipper-cli.git"
+	},
+	"homepage": "https://github.com/mohsingdp-ai/obsidian-clipper-cli#readme",
+	"bugs": {
+		"url": "https://github.com/mohsingdp-ai/obsidian-clipper-cli/issues"
+	},
 	"bin": {
 		"obsidian-clipper": "./dist/cli.cjs",
 		"obsidian-clipper-cli": "./dist/cli.cjs"