🪻 distributed transcription service
thistle.dunkirk.sh
docs: add comprehensive tangled-cli usage documentation
Added detailed documentation for tangled-cli including:
- Authentication and installation
- Creating, listing, showing, editing issues
- Commenting on issues
- Repository commands
- Priority label filtering
- JSON output format
- Known issues with the CLI
+107
+107
CRUSH.md
+107
CRUSH.md
···
688
688
**Configuration:**
689
689
Set `WHISPER_SERVICE_URL` in `.env` (default: `http://localhost:8000`)
690
690
691
+
## Issue Tracking
692
+
693
+
This project uses [Tangled](https://tangled.org) for issue tracking via the `tangled-cli` tool.
694
+
695
+
**Installation:**
696
+
```bash
697
+
cargo install --git https://tangled.org/vitorpy.com/tangled-cli
698
+
```
699
+
700
+
**Authentication:**
701
+
```bash
702
+
tangled-cli auth login
703
+
```
704
+
705
+
**Creating issues:**
706
+
```bash
707
+
tangled-cli issue create --repo "thistle" --title "Issue title" --body "Issue description"
708
+
709
+
# With labels (if created in the repo):
710
+
tangled-cli issue create --repo "thistle" --title "Issue title" --label "bug" --label "priority:high" --body "Issue description"
711
+
```
712
+
713
+
**Listing issues:**
714
+
```bash
715
+
# List all open issues
716
+
tangled-cli issue list --repo "thistle"
717
+
718
+
# List with specific state
719
+
tangled-cli issue list --repo "thistle" --state open
720
+
tangled-cli issue list --repo "thistle" --state closed
721
+
722
+
# List by label
723
+
tangled-cli issue list --repo "thistle" --label "priority: low"
724
+
tangled-cli issue list --repo "thistle" --label "bug"
725
+
726
+
# List by author
727
+
tangled-cli issue list --repo "thistle" --author "username"
728
+
729
+
# JSON output format
730
+
tangled-cli issue list --repo "thistle" --format json
731
+
```
732
+
733
+
**Showing issue details:**
734
+
```bash
735
+
# Show specific issue by ID
736
+
tangled-cli issue show <issue-id>
737
+
738
+
# Show with comments
739
+
tangled-cli issue show <issue-id> --comments
740
+
741
+
# JSON format
742
+
tangled-cli issue show <issue-id> --json
743
+
```
744
+
745
+
**Commenting on issues:**
746
+
```bash
747
+
tangled-cli issue comment <issue-id> --body "Your comment here"
748
+
```
749
+
750
+
**Editing issues:**
751
+
```bash
752
+
# Update title
753
+
tangled-cli issue edit <issue-id> --title "New title"
754
+
755
+
# Update body
756
+
tangled-cli issue edit <issue-id> --body "New description"
757
+
758
+
# Close an issue
759
+
tangled-cli issue edit <issue-id> --state closed
760
+
761
+
# Reopen an issue
762
+
tangled-cli issue edit <issue-id> --state open
763
+
```
764
+
765
+
**Repository commands:**
766
+
```bash
767
+
# List your repositories
768
+
tangled-cli repo list
769
+
770
+
# Show repository details
771
+
tangled-cli repo info thistle
772
+
773
+
# Create a new repository
774
+
tangled-cli repo create --name "repo-name" --description "Description"
775
+
```
776
+
777
+
**Viewing issues by priority:**
778
+
779
+
The thistle repo uses priority labels:
780
+
- `priority: high` - Critical issues that need immediate attention
781
+
- `priority: medium` - Important issues to address soon
782
+
- `priority: low` - Nice-to-have improvements
783
+
784
+
```bash
785
+
# View all low priority issues
786
+
tangled-cli issue list --repo "thistle" --label "priority: low" --state open
787
+
788
+
# View all high priority issues
789
+
tangled-cli issue list --repo "thistle" --label "priority: high" --state open
790
+
```
791
+
792
+
**Note:** The repo name for this project is `thistle` (resolves to `dunkirk.sh/thistle` in Tangled). Labels are supported but need to be created in the repository first.
793
+
794
+
**Known Issues:**
795
+
- The CLI may have decoding issues with some API responses (missing `createdAt` field). If `tangled-cli issue list` fails, you can access issues via the web interface at https://tangled.org/dunkirk.sh/thistle
796
+
- For complex filtering or browsing, the web UI may be more reliable than the CLI
797
+
691
798
## Future Additions
692
799
693
800
As the codebase grows, document: