jiratui
A Textual User Interface for interacting with Atlassian Jira from your shell
File Explorer
Download Latest Version (.zip)- bug_report.md
- feature_request.md
- lint.yaml
- publish-to-pypi.yml
- publish-to-testpypi.yml
- test.yaml
- website.yml
- attachments.png
- comments.png
- configuration-manager.png
- create-work-item-screen.png
- design-add-comment-screen.svg
- design-attach-file-screen.svg
- design-attachments-tab.svg
- design-comments-tab.svg
- design-create-work-item-screen.svg
- design-details-tab.svg
- design-info-tab.svg
- design-links-tab.svg
- design-main-screen.svg
- design-relate-work-items-screen.svg
- design-related-tab.svg
- design-search-results.svg
- design-subtasks-tab.svg
- details-with-custom-fields.png
- flag-unflag-work-items.png
- jiratui-logo.png
- jiratui_home.png
- jiratui_start.png
- related.png
- subtasks.png
- web-links.png
- architecture.md
- cli-and-ui.md
- components.md
- index.md
- jira-api.md
- textual-framework.md
- use-cases.md
- code-style-guidelines.md
- codebase.md
- index.md
- pull-request-guidelines.md
- quick-start.md
- documentation.md
- index.md
- testing.md
- common-adf.md
- common-base.md
- common-users.md
- common-widgets.md
- filters.md
- related-work-items.md
- screens.md
- search.md
- work-item-attachments.md
- work-item-comments.md
- work-item-creation.md
- work-item-details.md
- work-item-web-links.md
- api-client.md
- api-dc.md
- api-v2.md
- api-v3.md
- config.md
- controller.md
- factories.md
- index.md
- models.md
- roadmap.md
- session.md
- __init__.py
- docstrings_parser.py
- configuration.md
- index.md
- permissions.md
- reference.md
- index.md
- index.md
- conf.py
- index.md
- jiratui
- make.bat
- Makefile
- requirements.txt
- theme.min.css
- theme.min.css.map
- app-homepage.png
- configuration-manager.png
- favicon.png
- jiratui-add-new-issue.png
- jiratui-built-in-help.png
- jiratui-comments.png
- jiratui-filter-search-results.png
- jiratui-full-text-search.png
- jiratui-issue-description.png
- jiratui-issue-details.png
- jiratui-issue-related-issues.png
- jiratui-jql-expression-editor-2.png
- jiratui-jql-expression-editor.png
- jiratui-search-issue.png
- jiratui-search-issues.png
- jiratui-start.png
- jiratui-subtasks.png
- theme.min.js
- theme.min.js.map
- popper.min.js
- bootstrap.min.js
- is.min.js
- swiper-bundle.min.css
- swiper-bundle.min.js
- getting-started.html
- index.html
- sitemap.xml
- __init__.py
- test_actions.py
- test_bindings.py
- __init__.py
- constants.py
- keys.py
- assignable_users_search.json
- evaluate_expression.json
- issue.json
- issue_create_meta_required_fields.json
- issue_remote_links.json
- project.json
- project_statuses.json
- statuses.json
- __init__.py
- test_api.py
- test_client.py
- test_jira_software_cloud_api.py
- test_utils.py
- __init__.py
- api.py
- client.py
- utils.py
- issue.json
- issue_no_adf.json
- issue_remote_links.json
- __init__.py
- test_controller.py
- test_factories.py
- __init__.py
- constants.py
- controller.py
- factories.py
- __init__.py
- test_handlers.py
- __init__.py
- handler.py
- render.py
- config.tcss
- jt.tcss
- __init__.py
- test_app.py
- test_attachments.py
- test_commands.py
- test_config.py
- test_confirmation_screen.py
- test_fulltext_search.py
- test_git.py
- test_jql_screen.py
- test_main_screen.py
- test_models.py
- test_search_results.py
- test_widgets.py
- __init__.py
- test_adf_to_md_conversion.py
- test_fields.py
- test_history.py
- test_styling.py
- test_urls.py
- test_work_item_updates.py
- __init__.py
- adf.py
- fields.py
- history.py
- in_app_help.md
- logging.py
- mime.py
- session.py
- styling.py
- test_utilities.py
- ui_actions.py
- urls.py
- work_item_updates.py
- __init__.py
- test_attachments.py
- __init__.py
- add.py
- attachments.py
- __init__.py
- test_comments.py
- __init__.py
- add.py
- comments.py
- test_base.py
- test_factory.py
- test_widgets.py
- __init__.py
- adf.py
- base.py
- constants.py
- factory_utils.py
- users.py
- widgets.py
- __init__.py
- test_create_work_item.py
- __init__.py
- factory.py
- fields.py
- screen.py
- __init__.py
- test_related_issues_widget.py
- __init__.py
- add.py
- related_issues.py
- __init__.py
- test_links.py
- __init__.py
- add.py
- links.py
- __init__.py
- test_goto.py
- test_history.py
- test_work_item_quick_view.py
- __init__.py
- config.py
- confirmation.py
- git.py
- goto.py
- help.py
- history.py
- jql.py
- quit.py
- server.py
- text_search.py
- work_item_quick_view.py
- test_flagging_screen.py
- test_issue_details_widget.py
- test_read_only_details.py
- test_update_dynamic_fields.py
- test_widgets_factory.py
- __init__.py
- details.py
- factory.py
- fields.py
- flag_work_item.py
- __init__.py
- test_info.py
- __init__.py
- info.py
- screens.py
- tabs.py
- __init__.py
- test_subtasks.py
- __init__.py
- subtasks.py
- __init__.py
- test_worklog_screen.py
- __init__.py
- screens.py
- widgets.py
- __init__.py
- base.py
- filters.py
- messages.py
- screen.py
- search.py
- __init__.py
- app.py
- cli.py
- config.py
- configuration_app.py
- conftest.py
- constants.py
- exceptions.py
- files.py
- models.py
- .gitignore
- .pre-commit-config.yaml
- .python-version
- .readthedocs.yaml
- CHANGELOG.md
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- flake.lock
- flake.nix
- jiratui.example.yaml
- LICENSE
- Makefile
- pyproject.toml
- README.md
- ruff.toml
- SECURITY.md
- uv.lock
# Installation Guide
1. Get the code
git clone https://github.com/whyisdifficult/jiratui
Downloads the entire project code from GitHub to your computer.
cd jiratui
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
pip install jiratui
Installs the package published on PyPI directly β no need to clone the source.
pipx install jiratui
Installs the CLI tool into an isolated environment via pipx.
brew install jiratui
Installs the pre-built package via Homebrew β no source build required.
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. Python
EasyPrerequisites
pip install jiratui
Installs the package published on PyPI directly β no need to clone the source.
If it runs without errors and prints output in the terminal, it worked.
Pulled directly from this repo's README.
4. Make
MediumPrerequisites
- 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).
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
Was this content helpful?
(0 ratings)