6 releases
0.5.2 | Feb 3, 2025 |
---|---|
0.5.1 | Feb 3, 2025 |
0.5.0-pre.0 | Jan 31, 2025 |
0.4.0 | Jan 30, 2025 |
0.3.5 | Jan 29, 2025 |
#24 in Template engine
470 downloads per month
225KB
5.5K
SLoC
TISH: The Tiny Shell
TISH is a small and fast Unix shell written in Rust. It aims to provide a powerful and customizable shell experience while keeping the codebase concise and efficient.
Features
- Rich Templating System: Support for conditional logic, variables, and complex string operations
- Git Integration: Built-in git status information in prompts
- Lua Scripting: Extensible through Lua scripts
- Modern CLI Features:
- Syntax highlighting
- Command completion
- History management
- Auto-cd navigation
- Custom Commands: Enhanced
ls
command with icons and color coding - Environment Management: Smart environment variable handling and expansion
Installation
cargo install tish
Usage
Basic Commands
tish # Start shell
tish -c "command" # Execute command and exit
tish -n # Start without loading environment
tish -H # Run in headless mode
tish -L # Login shell (loads .tish_profile)
Prompt Customization
Tish uses a powerful templating system for prompt customization. For detailed information about all templating features, see the full prompt documentation.
The default prompt template is:
{user}@{host} {path} {prompt}
Available template variables include:
{user}
: Current username{host}
: Hostname{path}
: Current path (with variants like path-pretty, path-folder){git.*}
: Git status information{prompt}
: Shell prompt character (# for root, % for users)
Git Integration
Git information is automatically available in templates:
{git.branch}
: Current branch name{git.status}
: Status indicators (+, ~, -){git.ahead}
,{git.behind}
: Commit difference with remote{git.working.changed}
: Working directory status{git.staging.changed}
: Staging area status
Configuration
Configuration is done through .tishrc
in your home directory:
-- Example configuration
config.history_size = 500
config.auto_cd = true
config.use_tish_ls = true
config.show_hidden = false
config.prompt = "{user}@{host} {path} {prompt} "
Development
Building from Source
git clone https://github.com/themackabu/tish
cd tish
cargo install --path .
Requirements
Unix-like operating system (Linux, macOS, BSD)
Dependencies
~28–58MB
~1M SLoC