Skip to content

Add a Quick start guide and usage section #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
imanimanyara merged 1 commit into from
Oct 4, 2026
Merged

Add a Quick start guide and usage section #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 28 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ status — ok

Maintaining a polyrepo Composer / npm / Python ecosystem means juggling: per-repo `composer.json` validation, CHANGELOG bumps, semver tagging, `git push --tags`, the Packagist update webhook, occasional Docker-image republishing, sometimes a parallel `npm publish` to a private registry — all wired together with bash scripts that drift out of sync the moment a repo gets renamed.

Existing multi-repo tools (`mr`, `mu-repo`, `gita`) stop at clone / pull / status; none of them know about Packagist webhooks, npm tokens, or CHANGELOG-bump conventions. `gendia` fills that gap. It treats a release as a *workflow* (verify → bump → tag → push → notify) and keeps the dev surface and the CI surface identical — `gendia release myorg/core 1.0.1` does the same thing on your laptop and inside a CI runner.
Existing multi-repo tools (`mr`, `mu-repo`, `gita`) stop at clone / pull / status; none of them know about Packagist webhooks, npm tokens, or CHANGELOG-bump conventions. `gendia` fills that gap. It treats a release as a *workflow* (verify → bump → tag → push → notify) and keeps the dev surface and the CI surface identical — `gendia release core 1.0.1` does the same thing on your laptop and inside a CI runner.

## Highlights

Expand Down Expand Up @@ -49,6 +49,31 @@ cd gendia
make install-dev
```

## Quick start guide and usage

### Getting started

```sh
gendia setup # first-run wizard; auto-detects the deployment shape
gendia init # scaffold ./gendia.json at the project root, then list your repos
mkdir -p ~/.config/gendia
cp examples/.env.example ~/.config/gendia/.env
chmod 600 ~/.config/gendia/.env # then add the tokens your credential_ref keys name
gendia doctor # preflight: env file, git/ssh binaries, agent, credentials
```

Both config files and the `.env` are described under [Configure](#configure).

### Usage

```bash
gendia status # one-line summary per repo
gendia sync --dry-run # show what would be pushed and notified, do nothing
gendia release core 1.0.1 # bump CHANGELOG, tag, push, notify
```

Every verb and modifier is listed under [Commands](#commands).

## Configure

Two files, both JSON. The machine-wide one declares accounts and registries; the per-project one declares the repos.
Expand Down Expand Up @@ -164,7 +189,7 @@ gendia verify # run each repo's verify[] comman

# Workstation setup (manage gendia's own config + the host's git identity):
gendia init [--out FILE] [--force] # scaffold a fresh gendia.json
gendia setup [local|vps|project|docker|k8s|ci] # interactive first-run wizard, autodetects shape
gendia setup [--shape=local|vps|project|docker|k8s|ci] # first-run wizard; autodetects the shape when omitted
gendia config {list|get|set|unset|edit|path|doctor} # manage the .env that holds tokens + paths
gendia doctor # full preflight: env file, git/ssh binaries, agent, credentials
gendia identity {list|check|apply|setup|init} # per-account git user.name / user.email / signing key
Expand Down Expand Up @@ -350,7 +375,7 @@ Or via Compose (recommended):
```bash
docker compose run --rm gendia status
docker compose run --rm gendia sync
docker compose run --rm gendia release myorg/core 1.0.1
docker compose run --rm gendia release core 1.0.1
```

Or via the Make targets:
Expand Down
Loading