Skip to main content

gc-shell

gc-shell is an intelligent interactive shell for macOS that combines normal terminal command execution with custom application and filesystem utilities.

Overview

This project provides a shell wrapper that:

  • forwards normal commands to the system shell (zsh)
  • maintains shell state such as the current working directory
  • supports macOS application discovery and fuzzy app launch/close
  • offers built-in file utilities like tree, preview, search, and recursive directory creation
  • integrates with an AI planning layer to choose the right tool for user requests

Key Features

  • scan — discover installed macOS applications and save a registry
  • open <app> — open an application, folder, or file by name
  • close <app> — close a running macOS application
  • apps — list registered applications
  • running — list currently running GUI applications
  • tree [path] [--depth N] — display a directory tree
  • preview <file> [--lines N] — preview a text or source file
  • mkp <dir> — recursively create directories
  • search <pattern> [--path <dir>] — search files by glob pattern
  • cd / clear / help — standard shell navigation and help commands

Installation

Install from PyPI (Recommended)

pip install gc-shell

Run the shell:

gc-shell

Development Setup

Clone the repository and install dependencies:

git clone https://github.com/GouthamReddy05/GC-Shell.git
cd GC-Shell

python3 -m venv .venv
source .venv/bin/activate

pip install --upgrade pip
pip install -r requirements.txt

Run:

python main.py

Configuration

If AI features require a Groq key, create a .env file in the project root with:

echo 'GROQ_API_KEY=your_key_here' > .env

The shell loads environment variables via python-dotenv during startup.

Usage

Start the shell with:

gc-shell

Then enter commands as you would in a normal terminal. Custom commands are handled by gc-shell; all other commands are forwarded to /bin/zsh.

AI Integration

The shell includes an AI planner built with langgraph and langchain, and supports models such as Qwen via OpenRouter.. The AI layer selects available tools for requests such as opening resources, changing directories, searching files, or running shell commands.

Requirements

  • macOS
  • Python 3.9+
  • rich
  • prompt_toolkit
  • langchain-core
  • langchain-openrouter
  • langgraph
  • python-dotenv

Project Structure

  • main.py — application entry point
  • shell.py — REPL loop and prompt handling
  • executor.py — command routing and shell state management
  • commands/ — custom command implementations
  • registry/ — macOS application scanner and registry loader
  • AI/ — AI planner, tool registry, and prompts
  • pyproject.toml — package metadata and dependencies

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gc_shell-0.1.8.tar.gz (17.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gc_shell-0.1.8-py3-none-any.whl (20.0 kB view details)

Uploaded Python 3

File details

Details for the file gc_shell-0.1.8.tar.gz.

File metadata

  • Download URL: gc_shell-0.1.8.tar.gz
  • Upload date:
  • Size: 17.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for gc_shell-0.1.8.tar.gz
Algorithm Hash digest
SHA256 a1a02ce37a2594a72673b5994670b8c66e285fbfa8e000bd7320418e114a0ba0
MD5 3efce8fda59b9ad0b060abfa88214f1c
BLAKE2b-256 e06148460df596b4fbdff10feed4c1fa6f4ac487679b7584a2ba23050323b25e

See more details on using hashes here.

File details

Details for the file gc_shell-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: gc_shell-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 20.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for gc_shell-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 df1c5393571e0608c36ad31af044b00a43e4823ae5d59f739ed4a2279640ee49
MD5 34b2f06a06f0111f01125e9de85579e7
BLAKE2b-256 bb24b48fca2e454497d300b01adefa1ff8d74cdefad8d1bd5e90fbdc169e6b58

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.8 This release

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page