Skip to content

Commit d10f858

Browse files
committed
Add FAQ documentation page
Covers private registries, ecosyste.ms relationship, and the Ruby origins.
1 parent 10d3021 commit d10f858

2 files changed

Lines changed: 30 additions & 0 deletions

File tree

content/docs/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ git-pkgs tracks your dependency history across git commits. Initialize a databas
1616
{{< card link="bisect" title="Bisect" subtitle="Binary search for dependency changes" >}}
1717
{{< card link="diff-driver" title="Diff Driver" subtitle="Readable lockfile diffs" >}}
1818
{{< card link="managing-packages" title="Managing Packages" subtitle="Install, add, update, remove" >}}
19+
{{< card link="faq" title="FAQ" subtitle="Common questions" >}}
1920
{{< /cards >}}
2021

2122
### Libraries

content/docs/faq.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: FAQ
3+
weight: 60
4+
---
5+
6+
## Does git-pkgs work with private registries?
7+
8+
For commands that **query registries** (`outdated`, `licenses`, SBOM enrichment):
9+
10+
git-pkgs extracts registry URLs from lockfiles when the format supports it:
11+
- npm: package-lock.json, yarn.lock, pnpm-lock.yaml, bun.lock
12+
- pypi: Pipfile.lock, poetry.lock, uv.lock
13+
- cargo, composer, gem lockfiles
14+
15+
If your lockfile points to a private registry (like Artifactory or GitHub Packages), those URLs are used automatically. However, git-pkgs doesn't currently read config files like `.npmrc` or `.pypirc` for registry URLs or credentials. Authenticated private registries aren't supported yet for registry queries.
16+
17+
For commands that **run package managers** (`install`, `add`, `remove`, `update`):
18+
19+
These delegate to the actual CLI tools, which respect their native config files. Private registries, proxies, and credentials work as you'd expect.
20+
21+
## How is git-pkgs related to ecosyste.ms?
22+
23+
[ecosyste.ms](https://ecosyste.ms) is a set of open APIs for package ecosystem data, created by [Andrew Nesbitt](https://nesbitt.io) (who also created git-pkgs). git-pkgs can query package registries directly, but ecosyste.ms also provides source repository information for each package which often gives a better picture.
24+
25+
You can bypass ecosyste.ms and query registries directly with `git config pkgs.direct true`. This is useful for private registries or airgapped environments.
26+
27+
## Wasn't this originally written in Ruby?
28+
29+
Yes. The [original git-pkgs](https://github.com/andrew/git-pkgs) was a Ruby gem. This Go rewrite ships as a single binary for easier installation and enables future integration with projects like [gittuf](https://gittuf.dev), [sbommit](https://github.com/sbommit), and [Forgejo](https://forgejo.org).

0 commit comments

Comments
 (0)