Calico Term

A modern cross-platform terminal emulator powered by Electron, Vite, React, and xterm.js, featuring an AI assistant for generating safe and reproducible shell commands.

Table of Contents

• Features
• Installation
• Configuration
• Usage
• Development
• Building
• Technologies
• Contributing
• License
• Acknowledgements

Features

• Multi-tab terminal sessions with persistent shell processes (bash/zsh on Unix, PowerShell on Windows)
• Real-time error detection and notification in terminal output based on common error patterns
• Embedded AI assistant sidebar (OpenAI GPT-4) for generating safe and clear shell command suggestions
• Syntax highlighting for code snippets via highlight.js
• Intuitive UI with custom window controls, draggable regions, and theming built on React, TypeScript, and Tailwind CSS
• Cross-platform support: Windows, macOS, and Linux
• Automated packaging and auto-update support via electron-builder

Installation

Prerequisites

• Node.js v18 or higher
• npm (or yarn)

git clone https://github.com/evermine18/calico-term.git
cd calico-term
npm install

Usage

Start the development environment with hot-reload:

npm run dev

Launch the Electron application:

npm run start

Development

• Format code: npm run format
• Lint code: npm run lint
• Type-check: npm run typecheck

Building

Perform a production build and package the application:

npm run build

Platform-specific builds:

# Windows
npm run build:win

# macOS
npm run build:mac

# Linux
npm run build:linux

Technologies

• Electron & Vite (electron-vite)
• React & TypeScript
• xterm.js & node-pty
• Tailwind CSS & highlight.js
• OpenAI GPT-4 for AI assistant integration
• electron-builder for packaging and auto-updates

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository
2. Create your feature branch (git checkout -b feature/YourFeature)
3. Commit your changes (git commit -m 'Add some feature')
4. Push to the branch (git push origin feature/YourFeature)
5. Open a Pull Request

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgements

• Based on the electron-vite template
• Inspired by xterm.js and community contributions