mirror of
https://github.com/phranck/TUIkit.git
synced 2026-05-21 09:50:35 +00:00
phranck
756390dce3
- Landing page (Astro) deploys to tuikit.dev via main repo GitHub Pages - DocC documentation deploys to docs.tuikit.dev via phranck/tuikit-docs - Use peaceiris/actions-gh-pages for cross-repo DocC deployment - Update documentation URLs to docs.tuikit.dev
TUIkit Project Creator
CLI tool for creating TUIkit terminal applications.
Quick Install
curl -fsSL https://raw.githubusercontent.com/phranck/TUIkit/main/project-template/install.sh | bash
This installs the tuikit command globally on your system.
Usage
tuikit init MyApp # Basic app
tuikit init sqlite MyApp # With SQLite database
tuikit init testing MyApp # With Swift Testing
tuikit init sqlite testing MyApp # All features
What Gets Created
MyApp/
├── Package.swift # Swift Package with TUIkit dependency
├── Sources/
│ ├── App.swift # Main entry point
│ ├── ContentView.swift # Root view
│ └── Database.swift # (if sqlite option used)
├── Tests/ # (if testing/xctest option used)
├── .swiftpm/ # Pre-configured Xcode scheme
├── README.md
└── .gitignore
Features
- Creates native Swift Packages (not .xcodeproj)
- Optional SQLite.swift integration
- Optional Swift Testing or XCTest
- Pre-configured Xcode scheme
- Cross-platform (macOS, Linux)
- XDG Base Directory compliant
Installation Details
The installer:
- Detects your platform (macOS/Linux)
- Installs to
/usr/local/binor~/.local/bin - Offers to update your shell PATH automatically
- Creates
tuikit-uninstallcommand for easy removal
Manual Installation
git clone https://github.com/phranck/TUIkit.git
cd TUIkit/project-template
./install.sh
Uninstall
tuikit-uninstall
Requirements
- macOS 15+ or Linux
- Swift 6.0+
- Bash shell
Documentation
License
MIT License