JiraBridge 0.1.0

JiraBridge

Interactive .NET CLI that synchronizes a Git repository’s markdown backlog with Jira (pull/push, validation, conflicts). The UI is keyboard-driven: command palette, screens per workflow, and explicit dry-run for pushes.

Prerequisites

• Git: Run inside a clone; the tool resolves the repo root by walking up to a .git directory.
• .NET: Matches the app target (net10.0 today). For the global tool, install a compatible .NET SDK/runtime as required by the shipped package.
• Terminal: Interactive stdin is required. If stdin is redirected, the app renders once and exits (no unattended/CI mode yet).

Install

From NuGet (recommended after publish)

dotnet tool install --global JiraBridge

Command name: jirabridge.

Update:

dotnet tool update --global JiraBridge

From a local .nupkg (pre-release testing)

dotnet tool install --global JiraBridge --add-source C:\path\to\folder\containing\nupkg

From source (contributors)

dotnet build JiraBridge.sln
dotnet run --project src/JiraBridge
dotnet test tests/JiraBridge.UnitTests

Quick start

1. cd into your Git repository.
2. Create .env in the repository root (see Environment). You can copy .env.example and fill in real values. Do not commit secrets.
3. Run jirabridge.
4. Choose configure, enter your Jira project key (e.g. SCRUM), confirm. This writes .jirabridge/settings.json, prepares the backlog folder, and refreshes Jira metadata cache.
5. Use pull / push / validate as needed. Use push dry-run before applying changes.

Full scenarios, troubleshooting, and settings.json fields: docs/user-guide.md.

Environment

Required variables (system environment or repo-root .env; .env does not override variables already set in the process):

Getting a token: In Atlassian account security, create an API token and paste it into JIRABRIDGE_JIRA_API_TOKEN. Step-by-step notes and links: docs/user-guide.md.

On first configure, .env.example is created in the repo root if missing.

Commands (interactive home screen)

Filter with the keyboard; Enter runs or opens a screen; Esc / Q as shown on the home screen.

There is no separate non-interactive CLI for these verbs today; the maintained surface is this interactive app.

Repository layout (defaults)

• Settings: .jirabridge/settings.json
• Metadata cache: .jirabridge/project-metadata.json (path configurable in settings)
• Conflicts store: .jirabridge/conflicts.json
• Default backlog root: docs/jira-bridge

Capabilities (summary)

• Interactive home with filterable command palette
• Configure flow with Jira metadata refresh
• Local validation
• Optional sprint-aware backlog tree (SprintMappingEnabled in settings)
• Push with dry-run and step-by-step progress
• Pull from Jira into repo artifacts
• Conflict listing, diff preview, interactive resolve strategies
• Tests: parser, domain defaults, fixture-style backlog scenarios

Distribution choice

Recommended: publish JiraBridge as a .NET global tool on NuGet.org (PackAsTool, command jirabridge). Same package works on Windows, Linux, and macOS with a suitable .NET runtime.

Alternatives: private NuGet feed, GitHub Releases attaching .nupkg, or documentation-only install-from-source. Container images are optional and not required for a CLI tool.

Documentation map

License

MIT — see LICENSE.