Skip to main content

File-based task management for AI agents with human-editable markdown storage.

Project description

Documentation Status https://github.com/MacHu-GWU/shai_tix-project/actions/workflows/main.yml/badge.svg https://codecov.io/gh/MacHu-GWU/shai_tix-project/branch/main/graph/badge.svg https://img.shields.io/pypi/v/shai-tix.svg https://img.shields.io/pypi/l/shai-tix.svg https://img.shields.io/pypi/pyversions/shai-tix.svg https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social&logo=github
https://img.shields.io/badge/Link-API-blue.svg https://img.shields.io/badge/Link-Install-blue.svg https://img.shields.io/badge/Link-GitHub-blue.svg https://img.shields.io/badge/Link-Submit_Issue-blue.svg https://img.shields.io/badge/Link-Request_Feature-blue.svg https://img.shields.io/badge/Link-Download-blue.svg

Welcome to shai_tix Documentation

https://shai-tix.readthedocs.io/en/latest/_static/shai_tix-logo.png

File-based task management for AI agents with human-editable markdown storage.

What is shai_tix?

shai_tix is a task management system designed primarily for AI agents (like Claude Code) while remaining fully accessible to humans. It uses plain files and directories as storage, so both AI and humans can read, edit, and track changes through git.

Design Philosophy

AI-First, Human-Friendly

  • For AI: CLI interface (shai-tix) with simple text output that AI can parse

  • For Humans: Markdown files you can browse, edit, and version control

Dual Storage Architecture

  • Filesystem (Source of Truth): Human-readable directories and markdown files

  • SQLite Index (Cache): Fast queries without scanning directories

Simple Two-Level Hierarchy

Story (Feature or Epic)
└── Task (Atomic work unit)

No deep nesting. If a task needs subtasks, promote it to a story.

Quick Start

For AI Agents (CLI):

# Create a story and tasks
shai-tix create_story "User Authentication" --description "Implement login/logout"
shai-tix create_task 1 "Create login form"
shai-tix create_task 1 "Add session management"

# Query and update
shai-tix list_stories
shai-tix update_task 2 --status COMPLETED

For Humans (File System):

.tix/
└── stories/
    └── story-2025-01-15-00001-user-authentication/
        ├── metadata.json          # {"status": "IN_PROGRESS"}
        ├── description.md         # Editable markdown
        └── tasks/
            └── task-2025-01-15-00002-create-login-form/
                ├── metadata.json
                └── description.md

Install

shai_tix is released on PyPI, so all you need is to:

$ pip install shai-tix

To upgrade to latest version:

$ pip install --upgrade shai-tix

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

shai_tix-0.1.1.tar.gz (17.7 kB view details)

Uploaded Source

Built Distribution

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

shai_tix-0.1.1-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

Details for the file shai_tix-0.1.1.tar.gz.

File metadata

  • Download URL: shai_tix-0.1.1.tar.gz
  • Upload date:
  • Size: 17.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.8

File hashes

Hashes for shai_tix-0.1.1.tar.gz
Algorithm Hash digest
SHA256 92ef8b1313917fa6ddf7990a18e3d7195fbabc7c7072d048803f91327578b4b7
MD5 42b3ab7977f3065112b9add145b1b56b
BLAKE2b-256 1142c18244c034ac074c5485d7790298a22411d95bd67a955b1bea1151dbd036

See more details on using hashes here.

File details

Details for the file shai_tix-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: shai_tix-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 18.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.8

File hashes

Hashes for shai_tix-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fe530c687b0634e640c0baa83d8e45d1e490be853e62e7f4958217e903dad517
MD5 3eb8a22dbf4da1100913061a7c0abf72
BLAKE2b-256 1b0610512063053eb667a02644d78618378442026a3f6f8eb5f834fa2a551f85

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