si - Command Line LLM Assistant

si is a command line tool written in Go that allows you to harness the power of Large Language Models (LLMs) directly from your terminal. Ask questions, generate commands, and get AI assistance without leaving your workflow.

Features

• Simple Querying: Ask questions and get concise answers
• Command Generation: Generate complex shell commands on the fly
• Streaming Responses: See responses as they're generated (with option to disable)
• Configurable: Use different LLM providers with customizable settings
• Pipe Support: Pipe content into si for context-aware responses

Installation

Prerequisites

• Go 1.23 or higher

Building from Source

git clone https://github.com/Turee/si.git
cd si
go build -o bin/si cmd/si/main.go

Adding to PATH

# Add to your shell configuration file (.bashrc, .zshrc, etc.)
export PATH=$PATH:/path/to/si/bin

Usage Examples

Simple Questions

si what is the capital of France?
# Output: Capital of France is Paris

Command Generation

si write a ffmpeg command that encodes all video files in current directory as h265
# Output: ffmpeg -i *.mp4 -c:v libx265 -crf 28 -c:a aac -b:a 128k output_%03d.mp4

Piping Content

cat error_log.txt | si explain this error

Configuration

si is configured via a YAML file located at ~/.config/si.yaml.

Sample Configuration

llm:
  openai:
    # Base URL for the OpenAI API. You can specify:
    # - Full endpoint URL: https://api.openai.com/v1/chat/completions
    # - Base API URL: https://api.openai.com/v1
    # - For Azure, use your Azure OpenAI resource endpoint
    base_url: https://api.openai.com/v1

    # Your OpenAI API key or Azure API key
    api_key: your-api-key

    # Model name to use (default: gpt-4)
    # model_name: gpt-4

    # For Azure OpenAI, specify your deployment name
    # azure_deployment_name: optional-azure-deployment-name

Command Line Options

Flag	Description
--config	Path to config file (default: ~/.config/si.yaml)
--debug	Enable debug mode
--version	Show version information
--no-stream	Disable streaming responses

Development

Project Structure

• cmd/si/ - Main application code
• pkg/config/ - Configuration handling
• pkg/llm/ - LLM provider implementations

Running Tests

go test ./...

License

[MIT License]

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

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

Acknowledgments

• Built with Kong CLI
• Supports OpenAI and Azure OpenAI APIs

Release Process

This project uses Conventional Commits and Semantic Versioning for automated releases. The release process is fully automated through GitHub Actions.

How It Works

1. When code is pushed to the main branch, the release workflow automatically:
   • Builds and tests the code
   • Analyzes commit messages since the last release
   • Determines the next version number
   • Generates a changelog
   • Creates a GitHub release with binary assets
   • Updates version references in the codebase

Conventional Commits

To ensure the automated release process works correctly, commit messages should follow the Conventional Commits format:

<type>[(optional scope)]: <description>

[optional body]

[optional footer(s)]

Where type is one of:

• feat: A new feature (triggers a MINOR version bump)
• fix: A bug fix (triggers a PATCH version bump)
• docs: Documentation changes only
• style: Changes that don't affect the code's meaning (whitespace, formatting, etc.)
• refactor: Code changes that neither fix a bug nor add a feature
• perf: Performance improvements
• test: Adding or correcting tests
• chore: Changes to the build process or auxiliary tools

Breaking changes should be indicated with a ! after the type/scope or with a footer BREAKING CHANGE::

feat!: remove deprecated API

or

feat: add new API

BREAKING CHANGE: previous API has been removed

Breaking changes trigger a MAJOR version bump.

Example Commits

feat(api): add user authentication
fix(ui): resolve button alignment in dark mode
docs: update installation instructions
chore: update dependency versions
feat!: redesign user interface

For more detailed information, see the Conventional Commits specification.