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.6.tar.gz (15.3 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.6-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gc_shell-0.1.6.tar.gz
  • Upload date:
  • Size: 15.3 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.6.tar.gz
Algorithm Hash digest
SHA256 10531d6900eebbff436f107698b22449d5cfc6013bcb100b563b9bb5997cc1df
MD5 2fc2b5f7f17b7f98fc895474fa9a3023
BLAKE2b-256 bbf4bae7c99ff221e6401ee6df11da6d1b09d435739d782454da2e7d78de0477

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gc_shell-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 17.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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 71e514ae006306e995a9afb14b704f31926b31d6b37b8cb3087bc1083b5487c7
MD5 3f3a479e5b3a34efc1fdc5b33722ec30
BLAKE2b-256 2358a431c52c16d541346f5323d53624bc7374b97a81f1e72034018bf473456a

See more details on using hashes here.

Release history Release notifications | RSS feed

0.1.8

2 files

0.1.7

2 files

This release

0.1.6 This release

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