ai-sh - Intelligent Shell Suggestions
================================================

This is ai-sh, a free software package written in C that extends the
Bash shell with intelligent suggestions and completions.  The system
uses lightweight AI models trained on the user’s own command history,
programming habits, and directory context to provide context-aware
hints while working in the command line.

ai-sh is designed as a companion to GNU Bash, enhancing productivity
without altering the familiar shell environment.  All intelligence is
computed locally; no external network services are required.

------------------------------------------------------------------------
Features
------------------------------------------------------------------------

  * Smart suggestions while typing commands in Bash.
  * Adaptive learning from:
      - Command history (`~/.bash_history`)
      - Project directory structure
      - Programming patterns in source files
      - Shell scripting habits
  * Inline completion of commands, options, and arguments.
  * Context-aware directory navigation and file suggestion.
  * Configurable suggestion modes (silent, hint-only, auto-complete).
  * AI models embedded in C, no heavyweight frameworks required.
  * Fully offline, privacy-preserving design.

------------------------------------------------------------------------
Requirements
------------------------------------------------------------------------

  * A C99-compatible compiler (GCC recommended).
  * GNU Readline and GNU History libraries.
  * GNU Bash (tested with version 5.x and later).
  * POSIX-compatible operating system (GNU/Linux recommended).

------------------------------------------------------------------------
Installation
------------------------------------------------------------------------

To build ai-sh, run:

   ./configure
   make
   make install

The `configure` script supports standard GNU options such as
`--prefix` for installation directories.  See `INSTALL` for more
details.

After installation, enable ai-sh in Bash by sourcing the initialization
script in your `.bashrc`:

   eval "$(ai-sh init)"

------------------------------------------------------------------------
Usage
------------------------------------------------------------------------

ai-sh works transparently inside Bash.  While typing, suggestions will
appear inline.  Press `Tab` to accept or `Ctrl-Space` to cycle through
alternatives.

Example session:

   $ git ch
   suggestion: git checkout
   $ git checkout -b feature/ai-shell

   $ cd sr
   suggestion: cd src/

   $ make te
   suggestion: make test

ai-sh learns as you work.  Frequent commands and patterns will be
prioritized in suggestions.

------------------------------------------------------------------------
Documentation
------------------------------------------------------------------------

Full documentation is provided in Texinfo format.  To read it, type:

   info ai-sh

HTML and PDF manuals can be generated from the Texinfo sources in the
`doc/` directory.

------------------------------------------------------------------------
License
------------------------------------------------------------------------

ai-sh is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 3 of the License, or (at your
option) any later version.

ai-sh is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

A copy of the GNU GPL is provided in the file `COPYING`.

------------------------------------------------------------------------
Contributing
------------------------------------------------------------------------

Bug reports, feature requests, and patches are welcome.  Please send
them to the ai-sh mailing list (see `MAILING-LIST`) or use the project
issue tracker.

------------------------------------------------------------------------
Authors
------------------------------------------------------------------------

ai-sh was originally written by 4137314 and contributors.  See the file
`AUTHORS` for a complete list of contributors.