whodb

(โ˜… 5,010)

Where data access meets operational intelligence

  • .claudeignore
  • .gitattributes
  • .gitignore
  • .gitleaks.toml
  • .gitmodules
  • .trivyignore
  • AGENTS.md
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • DESIGN.md
  • ee
  • generate-docs-screenshots.sh
  • generate-microsoft-store-logos.sh
  • glama.json
  • go.work
  • go.work.desktop-ce
  • go.work.desktop-ce.sum
  • go.work.sum
  • LICENSE
  • logo.png
  • medusa.yml
  • NOTICE
  • PRODUCT.md
  • README.md
  • SECURITY.md
  • snapcraft.yaml
  • tidy-go-mods.sh

# Installation Guide

1. Get the code
git clone https://github.com/clidey/whodb

Downloads the entire project code from GitHub to your computer.

cd whodb

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Node.js Node.js must be installed to use npm.
curl -fsSL https://raw.githubusercontent.com/clidey/whodb/main/cli/install/install.sh | bash

Downloads and runs the official install script in one line โ€” this handles the full setup automatically.

npm install -g @clidey/whodb

Installs the package published on the npm registry globally โ€” no need to clone the source.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker run --rm -it -p 8080:8080 clidey/whodb

Runs the built image as an actual container.

docker run -it -p 8080:8080 \

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install -g @clidey/whodb

Installs the package published on the npm registry globally โ€” no need to clone the source.

pnpm install

Downloads and installs the libraries listed in package.json.

pnpm start

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

5. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
pip install .

Installs the package published on PyPI directly โ€” no need to clone the source.

python <์‹คํ–‰ํ•  ํŒŒ์ผ๋ช…>.py # README์—์„œ ์ •ํ™•ํ•œ ์‹คํ–‰ ํŒŒ์ผ๋ช…์„ ํ™•์ธํ•˜์„ธ์š”

Runs the Python script (or module).

โœ… If it runs without errors and prints output in the terminal, it worked.

6. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
go run ./cmd/whodb

Runs the Go program directly without a separate build step.

โœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

Pulled directly from this repo's README.

7. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
cd cli

This project's files live in a subfolder, so move into it first.

make

Compiles the code based on the generated build configuration to produce an executable.

โœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation