coulomb/markitect-main
2
0
Fork 0
Code Issues 60 Pull Requests Actions 1 Projects 12 Releases 1 Wiki Activity

CLI Entry Point and Basic Commands #12

New Issue
Closed
opened 2025-09-24 21:30:20 +00:00 by tegwick · 0 comments
tegwick commented 2025-09-24 21:30:20 +00:00
Owner
Copy Link

UseCase: The user can interact with MarkiTect through a command-line interface to access core functionality.

Technical Requirements:
The CLI should provide entry point commands for basic operations:

  • markitect ingest <file.md> - Process and store a Markdown file
  • markitect status <file.md> - Show processing status and metadata
  • markitect list - List all stored files and their status

Technical Implementation:

  • Use Click or Typer framework for argument parsing
  • Wire existing library components (database.py, document_manager.py) to CLI
  • Provide proper error handling and user-friendly output
  • Support global options like --verbose, --config, --database
  • Include comprehensive help text and examples

Acceptance Criteria:

  • CLI entry point configured in pyproject.toml
  • Core commands (ingest, status, list) implemented
  • Integration with existing database and caching systems
  • Proper error handling and user feedback
  • Help text and usage examples
  • Comprehensive test coverage following TDD workflow

Dependencies:

  • Issue #1 (database) and Issue #2 (document loading)
  • Use existing DatabaseManager and DocumentManager classes

Priority: High
Implementation Foundation: Build on Issue #1 (database) and Issue #2 (document loading). Use existing DatabaseManager and DocumentManager classes. Maintain performance caching from document_manager.py

UseCase: The user can interact with MarkiTect through a command-line interface to access core functionality. Technical Requirements: The CLI should provide entry point commands for basic operations: - `markitect ingest <file.md>` - Process and store a Markdown file - `markitect status <file.md>` - Show processing status and metadata - `markitect list` - List all stored files and their status Technical Implementation: - Use Click or Typer framework for argument parsing - Wire existing library components (database.py, document_manager.py) to CLI - Provide proper error handling and user-friendly output - Support global options like --verbose, --config, --database - Include comprehensive help text and examples Acceptance Criteria: - [ ] CLI entry point configured in pyproject.toml - [ ] Core commands (ingest, status, list) implemented - [ ] Integration with existing database and caching systems - [ ] Proper error handling and user feedback - [ ] Help text and usage examples - [ ] Comprehensive test coverage following TDD workflow Dependencies: - Issue #1 (database) and Issue #2 (document loading) - Use existing DatabaseManager and DocumentManager classes Priority: High Implementation Foundation: Build on Issue #1 (database) and Issue #2 (document loading). Use existing DatabaseManager and DocumentManager classes. Maintain performance caching from document_manager.py
tegwick added this to the CLI Implementation milestone 2025-09-24 21:46:33 +00:00
tegwick added this to the Getting started project 2025-09-24 22:00:19 +00:00
tegwick moved this to Todo in Getting started on 2025-09-24 22:02:47 +00:00
tegwick moved this to Active in Getting started on 2025-09-24 22:05:07 +00:00
tegwick moved this to Done in Getting started on 2025-09-25 00:44:21 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
priority:critical
Critical priority issue
 priority:high
High priority issue
 priority:low
Low priority issue
 priority:medium
Medium priority issue
 status:active
Issues currently being worked on
 status:blocked
Issues blocked by dependencies
 status:done
Completed issues
 status:review
Issues under review
 status:todo
Issues ready to be worked on
 type:bug
Bug report
 type:documentation
Documentation update
 type:enhancement
Enhancement to existing feature
 type:feature
New feature request
 wish
Feature wishlist item - idea to be discussed and refined
 wish/archived
Archived or rejected wishlist item
 wish/discussion
Wishlist item currently being discussed and refined
 wish/draft
Wishlist item with initial draft specification
 wish/ready
Wishlist item ready to become a regular issue
No Label
Milestone
No items
No Milestone CLI Implementation
Projects
Clear projects
No project Getting started
Assignees
Clear assignees
bubble-reader tegwick
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: coulomb/markitect-main#12
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?