From d72e3497b4b1d12938fbe1d69f539b0f2ea10a42 Mon Sep 17 00:00:00 2001 From: Aidan Bleser Date: Wed, 21 May 2025 10:42:17 -0500 Subject: [PATCH] feat: document info command --- package.json | 2 +- src/lib/docs/cli/info.md | 45 ++++++++++++++++++++++++++++++++++++++++ src/lib/docs/map.ts | 4 ++++ static/docs/cli/llms.txt | 12 +++++++++++ 4 files changed, 62 insertions(+), 1 deletion(-) create mode 100644 src/lib/docs/cli/info.md diff --git a/package.json b/package.json index 09810d5..8151ff3 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,7 @@ "private": true, "version": "0.0.1", "type": "module", - "packageManager": "pnpm@10.7.1", + "packageManager": "pnpm@10.11.0", "scripts": { "dev": "concurrently \"pnpm dev:content\" \"vite dev\"", "build": "pnpm build:content && pnpm build:svelte", diff --git a/src/lib/docs/cli/info.md b/src/lib/docs/cli/info.md new file mode 100644 index 0000000..d159aa6 --- /dev/null +++ b/src/lib/docs/cli/info.md @@ -0,0 +1,45 @@ +--- +title: info +description: Get info about a registry hosted on jsrepo.com. +lastUpdated: 5-21-2025 +--- + +```sh +jsrepo info +``` + +## Usage + +Get formatted information about a registry on jsrepo.com: + +```sh +jsrepo info @ieedan/std +``` + +Get information registry on jsrepo.com formatted as json: + +```sh +jsrepo info @ieedan/std --json +``` + +## Options + +### `--json` + +Output the response in formatted JSON.. + +#### Usage + +```sh +jsrepo info @ieedan/std --json +``` + +### `-h, --help` + +Help with the command. + +#### Usage + +```sh +jsrepo info --help +``` diff --git a/src/lib/docs/map.ts b/src/lib/docs/map.ts index a8c7dcb..8e67aff 100644 --- a/src/lib/docs/map.ts +++ b/src/lib/docs/map.ts @@ -121,6 +121,10 @@ const tempMap: Record = { title: 'exec', slug: 'exec' }, + { + title: 'info', + slug: 'info' + }, { title: 'init', slug: 'init' diff --git a/static/docs/cli/llms.txt b/static/docs/cli/llms.txt index 4799b0f..d45e154 100644 --- a/static/docs/cli/llms.txt +++ b/static/docs/cli/llms.txt @@ -100,6 +100,18 @@ jsrepo exec [options] [script] - --verbose: Include debug logs. - --cwd : The current working directory. (default: ./) +### info + +Get info about a registry hosted on jsrepo.com. + +#### Usage +```bash +jsrepo info [options] +``` + +#### Options +- --json: Output the response in formatted JSON. + ### init Initializes your project with a configuration file.