githits 0.20.0 → 0.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  # GitHits Code And Docs CLI Reference
2
2
 
3
- Package target syntax requires an explicit registry: `registry:name[@version]`, for example `npm:express@5.2.1`; omit `@version` for the latest release. Package targets inspect an indexed artifact/manifest root. Swift package targets use `swift:github.com/<owner>/<repo>` and Zig package targets use `zig:gh/<owner>/<repo>`. Use public repository targets for full repositories or sibling packages. Repository compact targets use `github:org/repo[@ref]`, `codeberg:owner/repo[@ref]`, `gitlab:group[/subgroup...]/project[@ref]`, `github.com/org/repo[@ref]`, or `https://github.com/org/repo[@ref]`; omitted refs request the backend default-branch intent. Exact standalone documentation sites use `site:<host[/path]>`. Output uses canonical `provider:path@ref` formatting so refs can contain `@` safely. `code` commands also support `--repo-url <url> [--git-ref <ref>]`.
3
+ Package target syntax requires an explicit registry: `registry:name@version`, for example `npm:express@5.2.1`; omit `@version` for the latest release. Package targets scope to the package subpath, including within monorepos. Swift package targets use `swift:github.com/<owner>/<repo>` and Zig package targets use `zig:gh/<owner>/<repo>`. Use public repository targets for full repositories or sibling packages. Repository compact targets use `github:org/repo@ref`, `codeberg:owner/repo@ref`, `gitlab:group/subgroup/project@ref`, `github.com/org/repo@ref`, or `https://github.com/org/repo@ref`; omit `@ref` for the backend default branch. Exact standalone documentation sites use `site:<host[/path]>`. Output uses canonical `provider:path@ref` formatting so refs can contain `@` safely. `code` commands also support `--repo-url <url>` with optional `--git-ref <ref>`.
4
4
 
5
5
  ## Search
6
6
 
@@ -26,21 +26,22 @@ This guide owns shared policy; selected tools own call syntax and exceptions.
26
26
  | Assess a package's license, adoption, maintenance, or overall health | `pkg_info` |
27
27
  | Inspect vulnerabilities in a package or version | `pkg_vulns` |
28
28
  | Inspect direct dependencies or transitive footprint | `pkg_deps` |
29
- | Find release notes for a package or repository | `pkg_changelog` |
29
+ | Find release notes and changelog history for a package | `pkg_changelog` |
30
30
  | Compare current and target dependency versions for an upgrade | `pkg_upgrade_review` |
31
31
  | Find canonical implementation examples across projects | `get_example` |
32
32
  | Check progress of an earlier search reference | `search_status` |
33
33
 
34
34
  For comparisons, combine relevant package/source evidence with examples as needed.
35
35
 
36
- Public OSS only; never send local/private/proprietary source. Packages use
37
- `registry:name[@version]` for an indexed artifact/manifest root; Swift uses
36
+ Public OSS only; never send local/private/proprietary source. Package/repository
37
+ patterns are `registry:name@version` and `github:owner/repo@ref`. Omit the
38
+ suffix for the latest package version or repository default branch. Package
39
+ targets scope to the package subpath, including in monorepos. Swift uses
38
40
  `swift:github.com/<owner>/<repo>`, Zig `zig:gh/<owner>/<repo>`.
39
41
  Use public repository targets for full repositories or sibling packages:
40
42
  `github:`, `codeberg:`, `gitlab:`, or a supported full URL. Never infer a provider.
41
- Revisions use `@ref` and may contain later `@` characters; `#` is reserved
42
- for semantic fragments, not revisions. Selected tools state supported forms
43
- and pin/ref restrictions.
43
+ A ref may be a branch, tag, or commit and contain later `@`; `#` is for
44
+ semantic fragments, not revisions.
44
45
 
45
46
  For a package or site docs topic, use `search` with `source:"docs"`.
46
47
  `docs_list` browses package pages, not standalone `site:` targets.
@@ -21,7 +21,7 @@ Use GitHits package intelligence before making dependency claims from memory.
21
21
 
22
22
  - Most package commands use `<registry>:<name>[@<version>]`, for example `npm:lodash@4.17.20` or `pypi:requests`.
23
23
  - `pkg info` always reports the latest published version and does not accept a version pin.
24
- - `pkg changelog` accepts `<registry>:<name>` or `--repo-url <url>`; do not pass `<spec>@<version>` to changelog. Use `--to <version>` instead.
24
+ - `pkg changelog` is package-only. Pin `@version` for one release; use `@from..to` or `--from`/`--to` for ranges. Repository and site targets are rejected.
25
25
 
26
26
  ## Core Commands
27
27
 
@@ -39,8 +39,8 @@ githits pkg deps npm:express --lifecycle all
39
39
  githits pkg deps npm:express --depth 3
40
40
 
41
41
  githits pkg changelog npm:express --limit 3
42
+ githits pkg changelog npm:express@5.2.1
42
43
  githits pkg changelog npm:express --from 4.18.0 --to 4.19.0
43
- githits pkg changelog --repo-url https://github.com/expressjs/express --limit 2 --no-body
44
44
 
45
45
  githits pkg upgrade-review npm:zod@4.3.6 --to 4.4.3
46
46
  githits pkg upgrade-review --package npm:zod@4.3.6..4.4.3 --package npm:lint-staged@16.2.7..16.4.0
@@ -54,7 +54,7 @@ githits pkg upgrade-review --package npm:zod@4.3.6..4.4.3 --package npm:lint-sta
54
54
  - Need historical advisories that do not affect the inspected version: use `pkg vulns --scope non_affecting`; use `--scope all` for affected plus historical rows.
55
55
  - Need dependency footprint: start with `pkg deps`; add `--lifecycle all` for non-runtime groups and `--depth <n>` for aggregate transitive graph data.
56
56
  - Need upgrade evidence for dependency updates, outdated package bumps, or lockfile changes: prefer `pkg upgrade-review` because it compares current vs target vulnerabilities, changelog range evidence, deprecation metadata, peer changes, dependency changes, and transitive security evidence by default. It reports facts only; you still own the final assessment.
57
- - Need release notes without a current-to-target comparison: use `pkg changelog`; use `--from`/`--to` for ranges and `--no-body` for compact timelines.
57
+ - Need release notes without a current-to-target comparison: use `pkg changelog`; `--no-body` for compact timelines.
58
58
 
59
59
  ## Gotchas
60
60
 
@@ -31,13 +31,11 @@ Use `--depth` to request capped transitive output. Without it, output is direct
31
31
 
32
32
  ## Changelog
33
33
 
34
- `githits pkg changelog <registry:name>` returns recent release notes. `--limit` caps latest mode. `--from` is the exclusive lower bound for range mode, which returns entries after `--from` through `--to` (or latest).
34
+ `githits pkg changelog <registry:name[@version|@from..to]>` returns release notes for a package. Bare targets use latest mode. Pin `@version` for one selected release. Use `@from..to`, `@from..`, or `@..to` for interval and upper-cap forms.
35
35
 
36
- Flags: `--repo-url <url>`, `--from <version>`, `--to <version>`, `--limit 1-50`, `--git-ref <ref>`, `--verbose`, `--no-body`, `--json`.
36
+ Flags: `--from <version>`, `--to <version>`, `--limit 1-50`, `--verbose`, `--no-body`, `--json`.
37
37
 
38
- Do not use `registry:name@version` for changelog. `--to <version>` is an upper cap, not an exact-release lookup.
39
-
40
- For repository changelogs, pass a full HTTPS URL on github.com, codeberg.org, or gitlab.com to `--repo-url`; use `--git-ref` for a branch or tag. Codeberg requires owner/repo; GitLab permits nested namespaces. Do not pass compact `github:`, `codeberg:`, or `gitlab:` targets to this URL field.
38
+ `--from` and `--to` remain package range flags on a bare spec. Inline single-release targets reject those flags and `--limit`. Repository and site targets are not supported.
41
39
 
42
40
  ## Upgrade Review
43
41