Skip to content

Repository files navigation

Jira Importer Toolkit

Excel → Jira-ready CSV, or direct Jira Cloud import — with validation, optional auto-fixes, and a standalone app.

Plan in Excel. Get issues Jira can accept—without hand-fighting CSV rules or cryptic import errors.

Who should read which doc?

You want to… Start here
Run the downloaded app (first successful import) Quick Start (README_APP.md) — also shipped with the build
Configure fields, tables, credentials docs/CONFIG.md
Understand Cloud import behavior docs/CLOUD.md
See the full feature list docs/FEATURES.md
Develop or contribute docs/DEV.md · docs/CONTRIBUTING.md

Important notice

--cloud works with Jira Cloud only (REST API v3).

  • CSV export works for Cloud, Server, and Data Center (manual upload in Jira).
  • Direct API import does not support Jira Server, Data Center, or legacy Jira.

Interested in Server/Data Center API support? Describe your constraints in GitHub Issues or via deerhide.run.

Who is this for?

Project managers, team leads, producers, and anyone who plans in Excel and later needs issues in Jira—especially if CSV import has been painful.

Why it exists

Jira CSV import is strict: columns, IDs, hierarchy, and field formats must match expectations, and failures are often hard to decode. This toolkit validates and cleans Excel data, then either writes a Jira-ready CSV or creates issues in Jira Cloud.

Download

Get the latest release — no install required on Windows or macOS.

Platform What you get
Windows Standalone jira-importer.exe (drag & drop Excel onto the EXE for CSV export)
macOS Native jira-importer binary
From source Python 3.12+ — contributors: see docs/DEV.md; package users: pip install jira-toolkit when published on PyPI

Templates

  • ImportTemplate.xlsx — in release bundles and in resources/templates/ in this repo.
  • ImportTemplate_with_config.xlsx — sample Config sheet; on Releases when published (not always in git).
  • JSON samplesresources/templates/ (config_importer.json, and related files).

Shipped builds include the app guide: README_APP.md.

60-second path

  1. Download the app and ImportTemplate.xlsx from Releases.
  2. Fill the Dataset sheet (keep the expected headers).
  3. Prefer a dry run, then choose CSV or Cloud:
# Windows
jira-importer.exe your-data.xlsx --dry-run
jira-importer.exe your-data.xlsx                 # → your-data_jira_ready.csv
jira-importer.exe your-data.xlsx --cloud         # Jira Cloud only

# macOS
./jira-importer your-data.xlsx --dry-run
./jira-importer your-data.xlsx
./jira-importer your-data.xlsx --cloud

Full walkthrough (verify success, credentials, troubleshooting): see README_APP.md.

Choose your import path

Path Use when Prerequisites You’re done when
CSV export Any Jira (Cloud / Server / DC); you want to review before upload Excel in template shape *_jira_ready.csv exists; you upload it via Jira Bulk create / CSV import
Cloud import (--cloud) Jira Cloud; create issues without manual upload Config (site + project) + credentials (--credentials run or env) Console shows create/submit summary; issues appear in the project
Dry run (--dry-run) First run or after config changes Same as above Processing completes with no output write / no Cloud create

Cloud credentials (interactive): jira-importer.exe --credentials run (macOS: ./jira-importer --credentials run).

Key capabilities

  • Excel (.xlsx) → Jira-compatible CSV and/or Jira Cloud API create
  • Validation for issue types, priorities, components, IDs, hierarchy, and more
  • Optional --auto-fix for safe, common corrections
  • Skips junk / note rows when configured
  • CLI and standalone binaries (Windows / macOS)
  • Rules and mappings via JSON or Excel Config (-ci / -ce)
  • Custom fields when configured (details in docs/CONFIG.md and docs/FEATURES.md)

CLI at a glance

Option Description
your-data.xlsx Input workbook
-c, --config Specific configuration file
-ce, --config-excel Excel Config sheet + config* / cfg* tables
-ci, --config-input Config file next to the Excel file (recommended for JSON)
-o, --output Output CSV path (default: <input>_jira_ready.csv next to the Excel file)
-cl, --cloud Create issues in Jira Cloud (requires connection config + credentials)
-cld, --cloud-debug-payloads Write Cloud API payloads to JSON (use with --cloud for resolved parent links; incompatible with --dry-run)
-y, --auto-yes / -n, --auto-no Auto-answer confirmation prompts
-af, --auto-fix Apply safe automatic fixes during validation
-fce, --fix-cloud-estimates Apply Jira Cloud ×60 estimate quirk in the Cloud sink
-q, --quiet Minimal output: errors, warnings, and one outcome line
-creds, --credentials [ACTION] run / show / clear / test
-ds, --data-sheet NAME Data tab name (default: Dataset)
-dr, --dry-run Process without writing output / creating issues
-sc, --show-config Show configuration (no input file required)
-d, --debug Verbose troubleshooting output
-v, --version Version information

Run jira-importer --help for the full live list. Hidden/internal flags are omitted here.

Input expectations (summary)

  • Prefer ImportTemplate.xlsx; do not rename headers unless you know the schema.
  • Default data sheet: Dataset (exact tab name).
  • Empty rows are ignored; configurable skip rules can drop note/comment rows.

For examples, custom fields, and row-skipping detail, see README_APP.md and docs/CONFIG.md.

Configuration (hub)

Method Flag Best for
Excel Config + tables -ce Single-file workflows; lookup tables in the workbook
JSON next to the Excel file -ci Shared/team config and automation
Explicit file -c Pointing at a known path

Excel tables (when using -ce): required — CfgAssignees, CfgIssueTypes, CfgIgnoreList, CfgPriorities, CfgAutofieldValues; optional — CfgSprints, CfgFixVersions, CfgComponents, CfgTeams, CfgCustomFields.

Deep reference: docs/CONFIG.md.

Docs map

Doc Audience
README_APP.md End users (shipped with the build)
docs/CONFIG.md Configuration
docs/CLOUD.md Cloud import
docs/FEATURES.md Feature inventory
docs/DEV.md Developers
docs/CONTRIBUTING.md Contributors
docs/ARCHITECTURE.md Maintainers / deep design

Roadmap (short)

Planned themes include published Linux release binaries, multi-file imports, richer templates, Server/Data Center API support, and deeper reporting.

Support

Repository: DeerHide/jira-toolkit License: MIT

About

Excel to Jira importer — validates data, fixes common errors, and generates Jira-ready CSVs for bulk import.

Topics

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Used by

Contributors

Languages