diff --git a/README.md b/README.md index 5cee3a9..6921ad1 100644 --- a/README.md +++ b/README.md @@ -4,25 +4,27 @@ Open-source diagnostics for checking what public websites return to crawlers. The CLI inspects returned HTML, compares browser-style and crawler-style responses, and validates common discovery files. It does not render JavaScript, change a website, require a Prerender Buddy account, or predict search rankings, indexing, AI citations, mentions, or traffic. -This is an early public release. The npm package is being prepared; until it is published, run the CLI from a local checkout. +This is an early public release. Install it from npm or run it from a local checkout. ## Requirements - Node.js 20 or newer - A public HTTP or HTTPS URL -Local usage: +Run without installing: ```bash -node ./bin/prerenderbuddy.js check https://example.com -node ./bin/prerenderbuddy.js compare https://example.com --user-agent gptbot -node ./bin/prerenderbuddy.js files https://example.com +npx @prerenderbuddy/cli check https://example.com +npx @prerenderbuddy/cli compare https://example.com --user-agent gptbot +npx @prerenderbuddy/cli files https://example.com ``` -Proposed usage after publication: +Local checkout usage: ```bash -npx @prerenderbuddy/cli check https://example.com +node ./bin/prerenderbuddy.js check https://example.com +node ./bin/prerenderbuddy.js compare https://example.com --user-agent gptbot +node ./bin/prerenderbuddy.js files https://example.com ``` ## Commands diff --git a/package-lock.json b/package-lock.json index 9024412..1957e0a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@prerenderbuddy/cli", - "version": "0.1.0", + "version": "0.1.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@prerenderbuddy/cli", - "version": "0.1.0", + "version": "0.1.1", "license": "Apache-2.0", "bin": { "prerenderbuddy": "bin/prerenderbuddy.js" diff --git a/package.json b/package.json index 167390f..addffd1 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,15 @@ { "name": "@prerenderbuddy/cli", - "version": "0.1.0", + "version": "0.1.1", "description": "Open-source crawler-readability and discovery-file diagnostics for public websites.", + "homepage": "https://github.com/kopachlager/prerenderbuddy-cli#readme", + "repository": { + "type": "git", + "url": "git+https://github.com/kopachlager/prerenderbuddy-cli.git" + }, + "bugs": { + "url": "https://github.com/kopachlager/prerenderbuddy-cli/issues" + }, "type": "module", "bin": { "prerenderbuddy": "bin/prerenderbuddy.js" diff --git a/src/cli.js b/src/cli.js index f2c082a..3fa4892 100644 --- a/src/cli.js +++ b/src/cli.js @@ -1,9 +1,14 @@ +import { readFileSync } from 'node:fs'; import { checkUrl } from './check.js'; import { compareUrl } from './compare.js'; import { checkDiscoveryFiles } from './discovery.js'; import { formatHuman } from './format.js'; import { USER_AGENT_PROFILES } from './profiles.js'; +const { version: VERSION } = JSON.parse( + readFileSync(new URL('../package.json', import.meta.url), 'utf8'), +); + const HELP = `Prerender Buddy CLI Usage: @@ -64,7 +69,7 @@ export async function runCli(args) { return; } if (options.version) { - process.stdout.write('0.1.0\n'); + process.stdout.write(`${VERSION}\n`); return; }