Skip to main content

Sync your .plan file with Jira Cloud

Project description

plajira

Sync your .plan file with Jira Cloud.

plajira is a command-line tool that bridges your personal .plan file with Jira, keeping your task tracking in sync without leaving your editor.

Features

  • Zero intrusion: Your .plan file is never modified by plajira
  • Git-aware: Only syncs items from commits that have been pushed
  • Timestamp-aware: Detects conflicts when Jira was updated more recently
  • Interactive: Every action requires confirmation
  • Portable: Python standard library only (no external dependencies)

Installation

pip install plajira

Or install from source:

git clone https://github.com/plajira/plajira.git
cd plajira
pip install -e .

Quick Start

  1. Initialize plajira in a directory containing your .plan file:
plajira init
  1. Copy .env.example to .env and add your Jira credentials:
cp .env.example .env
# Edit .env with your Jira URL, email, and API token
  1. Run your first sync:
plajira sync

.plan File Format

> 2026-01-07
* foo feedback
+ implement bar
! review baz spreadsheet
? begin legend mode implementation

> 2026-01-08
* touch base on foo feedback
* implement bar
? continue legend mode implementation
~ old abandoned idea

Markers

Marker Meaning Jira Status Creates new issue?
? In progress / planned In Progress Yes
* Accomplished that day Done Yes
! Idea for future work Backlog Yes
+ Accomplished later (was ?) Done No - transitions only
~ Abandoned (was ?) Won't Do No - transitions only

Note: + and ~ are for transitioning items that were previously tracked as ?. They won't create new Jira issues.

Commands

plajira init

Initialize plajira configuration in the current directory.

plajira status

Preview what would happen on sync, with an interactive menu.

$ plajira status

Checking .plan for duplicate lines... OK
Parsing .plan... 34 items
Checking git status... all commits

New items:
  • "research spec" [SUSPECTED DUPLICATE]
  • "baz spreadsheet"

Status changes:
  • CSD-42 "implement foobar": In Progress -> Done

Skipped: 3  Up to date: 28

[s] Sync  [v] View skip list  [l] List tracked  [q] Quit

Press v to view the skip list:

Skip list: (1-3 of 3)
  [1] "old task from last year"
  [2] "not really a task"
  [3] "duplicate entry"

[u] Unskip  [q] Back

Press u to unskip items by number. Lists with more than 10 items show [p] Prev and [n] Next for pagination.

plajira sync

Synchronize your .plan with Jira.

$ plajira sync

New item: "implement foobar"

  [y] Create new Jira issue
  [n] Not now (ask again next sync)
  [d] Duplicate - link to existing item
  [s] Skip (don't track in Jira)

Choice [y]: y

✓ Created CSD-72 "implement foobar"

--gojira mode

Use plajira sync --gojira to auto-create new items without prompting. This is useful for batch operations or CI pipelines.

In gojira mode:

  • New items are automatically created (no prompt)
  • Suspected duplicates still prompt for user input
  • Conflicts still prompt for user input
  • Transition failures auto-retry once, then prompt if still failing
  • Final confirmation is auto-approved

plajira link <text> <jira-key>

Manually link a .plan line to an existing Jira issue.

$ plajira link "implement foobar" CSD-42

Fetching CSD-42... found: "Implement foobar" (In Progress)

Link "implement foobar" -> CSD-42? [y/N]: y

✓ Linked.

plajira unlink <text>

Remove tracking for a line (doesn't affect Jira).

plajira list

Show all tracked items and skip list with interactive pagination.

$ plajira list

Tracked items: (1-2 of 2)

  CSD-42 (Done)
    • "implement foobar"

  CSD-71 (In Progress)
    • "research spec"
    • "continue research spec"

[q] Back

After pressing q, the skip list is shown (if any). Lists with more than 10 items show [p] Prev and [n] Next for pagination.

plajira unskip <text>

Remove a line from the skip list.

Configuration

Configuration is stored in .plajira (YAML format). Credentials are in .env.

.env

JIRA_URL=https://your-domain.atlassian.net
JIRA_EMAIL=your-email@example.com
JIRA_TOKEN=your-api-token

Get your API token from: https://id.atlassian.com/manage-profile/security/api-tokens

.plajira

The configuration file has two sections:

  1. config (user-editable): Jira settings, marker mappings, keywords
  2. state (managed by plajira): Tracked items and skip list

Duplicate Detection

plajira automatically detects suspected duplicates using:

  • Continuation keywords ("continue", "finish", etc.)
  • Word overlap (≥40% of significant words)
  • Fuzzy matching (Levenshtein similarity ≥50%)

When a suspected duplicate is found, you can link it to an existing item instead of creating a new Jira issue.

Conflict Resolution

If someone else updates a Jira issue after you changed your .plan, plajira detects the conflict:

⚠️  CONFLICT: "implement foo" (CSD-42)

Your .plan shows: * (Done)
  Changed: 2026-01-08 14:32

Jira shows: Blocked
  Changed: 2026-01-08 16:45

Jira was updated MORE RECENTLY than your .plan change.

  [s] Skip this item (recommended)
  [v] View Jira issue in browser
  [o] Override: force .plan status to Jira (dangerous!)

Choice [s/v/o]:

Requirements

  • Python 3.8+
  • Git repository with a remote tracking branch
  • Jira Cloud account with API access

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plajira-0.4.0.tar.gz (39.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

plajira-0.4.0-py3-none-any.whl (35.4 kB view details)

Uploaded Python 3

File details

Details for the file plajira-0.4.0.tar.gz.

File metadata

  • Download URL: plajira-0.4.0.tar.gz
  • Upload date:
  • Size: 39.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for plajira-0.4.0.tar.gz
Algorithm Hash digest
SHA256 e6f0b7c504b9de97c1de938cf3fffba592d2e8e2d4b0ce312f2e41771104be25
MD5 353baef681ec378fa56d5d417d604253
BLAKE2b-256 f01d9b00884c6ed3c766fd08f47fd86722b4acadeb68a2b7b4459621a03ef6a3

See more details on using hashes here.

File details

Details for the file plajira-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: plajira-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 35.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for plajira-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 62eea9484f16bc4144a838cd07deaf22f0c3a0b7a1b60af8d57790ef3c68cec6
MD5 975e63bca05a98c40a85f7867c6dc210
BLAKE2b-256 281d913b8e9f3ee7f21a3f4b15073b672876028acc7748319307d4e3af26a993

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page