https://github.com/ndom91/plain-tui
TUI app for interacting with your customer support
https://github.com/ndom91/plain-tui
plain react tui
Last synced: 2 months ago
JSON representation
TUI app for interacting with your customer support
- Host: GitHub
- URL: https://github.com/ndom91/plain-tui
- Owner: ndom91
- Created: 2025-09-15T08:40:46.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-09-15T13:50:27.000Z (9 months ago)
- Last Synced: 2025-12-25T13:12:21.451Z (6 months ago)
- Topics: plain, react, tui
- Language: TypeScript
- Homepage:
- Size: 4.19 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 💻 Plain TUI
A full-screen terminal application (TUI) for interacting with Plain, your favorite customer support system.
## ✨ Features
- **🎫 Threads**: View and manage support threads with filtering
- **👥 Customers**: Browse customer information
- **🏢 Tenants**: Manage tenant organizations
- **📜 Thread Timeline**: Detailed view with full conversation history
- **⌨️ Keyboard Navigation**: Vim-like keyboard shortcuts
## 🏗️ Setup
This TUI application is written using React's `ink` library and communicates
with Plain via their extensive [GraphQL API](https://app.plain.com/developer/api-explorer).
### Prerequisites
- A Plain workspace with API access
### Installation
1. Clone this repository
2. Install dependencies:
```bash
pnpm install
```
3. Create a configuration file at `~/.config/plain-tui.json`:
```json
{
"apiKey": "your-plain-api-key-here",
"endpoint": "https://core-api.uk.plain.com/graphql/v1"
}
```
You can create an API key under "Settings" > "Machine Users" in Plain,
include all permissions for full functionality.
4. Run the application:
```bash
pnpm run dev
```
## 📝 License
MIT