shell-sage 0.0.1__tar.gz

shell_sage-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022, fastai
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

shell_sage-0.0.1/MANIFEST.in

@@ -0,0 +1,5 @@
+include settings.ini
+include LICENSE
+include CONTRIBUTING.md
+include README.md
+recursive-exclude * __pycache__

shell_sage-0.0.1/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.1
+Name: shell_sage
+Version: 0.0.1
+Summary: Your favorite AI buddy right in your terminal
+Home-page: https://github.com/AnswerDotAI/shell_sage
+Author: ncoop57
+Author-email: nc@answer.ai
+License: Apache Software License 2.0
+Keywords: nbdev jupyter notebook python
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: Apache Software License
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: claudette
+Requires-Dist: fastcore
+Requires-Dist: rich
+Provides-Extra: dev
+
+# ShellSage
+
+## Usage
+
+### Installation
+
+Install latest from the GitHub
+[repository](https://github.com/AnswerDotAI/shell_sage):
+
+or from [pypi](https://pypi.org/project/shell_sage/)
+
+```sh
+pip install shell_sage
+```
+
+We recommend also setting up your terminal editor of choice to keep the editor content's displayed in the terminal on exit. This allows `ShellSage` to see the files you have been working on. Here is how you can do this in vim:
+
+```sh
+echo "set t_ti= t_te=" >> ~/.vimrc
+```
+
+## How to use
+
+`ShellSage` is designed to be ran inside a tmux session since it relies on tmux for getting what has is displayed on your terminal as context. If you don't want to use tmux, you will need to use the `--NH` command, which will not include your terminal history.
+
+```sh
+ssage hi ShellSage
+```
+
+```markdown
+Hello! I'm ShellSage, your command-line assistant. I can help you with:
+
+- Bash commands and scripting
+- System administration tasks
+- Git operations
+- File management
+- Process handling
+- And more!
+```
+
+You can also pipe outputs into `ShellSage`:
+
+```sh
+cat file.txt | ssage summarize this file
+```

shell_sage-0.0.1/README.md

@@ -0,0 +1,45 @@
+# ShellSage
+
+## Usage
+
+### Installation
+
+Install latest from the GitHub
+[repository](https://github.com/AnswerDotAI/shell_sage):
+
+or from [pypi](https://pypi.org/project/shell_sage/)
+
+```sh
+pip install shell_sage
+```
+
+We recommend also setting up your terminal editor of choice to keep the editor content's displayed in the terminal on exit. This allows `ShellSage` to see the files you have been working on. Here is how you can do this in vim:
+
+```sh
+echo "set t_ti= t_te=" >> ~/.vimrc
+```
+
+## How to use
+
+`ShellSage` is designed to be ran inside a tmux session since it relies on tmux for getting what has is displayed on your terminal as context. If you don't want to use tmux, you will need to use the `--NH` command, which will not include your terminal history.
+
+```sh
+ssage hi ShellSage
+```
+
+```markdown
+Hello! I'm ShellSage, your command-line assistant. I can help you with:
+
+- Bash commands and scripting
+- System administration tasks
+- Git operations
+- File management
+- Process handling
+- And more!
+```
+
+You can also pipe outputs into `ShellSage`:
+
+```sh
+cat file.txt | ssage summarize this file
+```

shell_sage-0.0.1/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=64.0"]
+build-backend = "setuptools.build_meta"

shell_sage-0.0.1/settings.ini

@@ -0,0 +1,45 @@
+[DEFAULT]
+# All sections below are required unless otherwise specified.
+# See https://github.com/fastai/nbdev/blob/master/settings.ini for examples.
+
+### Python library ###
+repo = shell_sage
+lib_name = %(repo)s
+version = 0.0.1
+min_python = 3.10
+license = apache2
+black_formatting = False
+
+### nbdev ###
+doc_path = _docs
+lib_path = shell_sage
+nbs_path = nbs
+recursive = True
+tst_flags = notest
+put_version_in_init = True
+
+### Docs ###
+branch = main
+custom_sidebar = False
+doc_host = https://%(user)s.github.io
+doc_baseurl = /%(repo)s
+git_url = https://github.com/%(user)s/%(repo)s
+title = %(lib_name)s
+
+### PyPI ###
+audience = Developers
+author = ncoop57
+author_email = nc@answer.ai
+copyright = 2024 onwards, %(author)s
+description = Your favorite AI buddy right in your terminal
+keywords = nbdev jupyter notebook python
+language = English
+status = 3
+user = AnswerDotAI
+
+### Optional ###
+requirements = claudette fastcore rich
+# dev_requirements = 
+console_scripts = ssage=shell_sage.core:main
+# conda_user = 
+# package_data =

shell_sage-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

shell_sage-0.0.1/setup.py

@@ -0,0 +1,64 @@
+from pkg_resources import parse_version
+from configparser import ConfigParser
+import setuptools, shlex
+assert parse_version(setuptools.__version__)>=parse_version('36.2')
+
+# note: all settings are in settings.ini; edit there, not here
+config = ConfigParser(delimiters=['='])
+config.read('settings.ini', encoding='utf-8')
+cfg = config['DEFAULT']
+
+cfg_keys = 'version description keywords author author_email'.split()
+expected = cfg_keys + "lib_name user branch license status min_python audience language".split()
+for o in expected: assert o in cfg, "missing expected setting: {}".format(o)
+setup_cfg = {o:cfg[o] for o in cfg_keys}
+
+licenses = {
+    'apache2': ('Apache Software License 2.0','OSI Approved :: Apache Software License'),
+    'mit': ('MIT License', 'OSI Approved :: MIT License'),
+    'gpl2': ('GNU General Public License v2', 'OSI Approved :: GNU General Public License v2 (GPLv2)'),
+    'gpl3': ('GNU General Public License v3', 'OSI Approved :: GNU General Public License v3 (GPLv3)'),
+    'bsd3': ('BSD License', 'OSI Approved :: BSD License'),
+}
+statuses = [ '1 - Planning', '2 - Pre-Alpha', '3 - Alpha',
+    '4 - Beta', '5 - Production/Stable', '6 - Mature', '7 - Inactive' ]
+py_versions = '3.6 3.7 3.8 3.9 3.10 3.11 3.12'.split()
+
+requirements = shlex.split(cfg.get('requirements', ''))
+if cfg.get('pip_requirements'): requirements += shlex.split(cfg.get('pip_requirements', ''))
+min_python = cfg['min_python']
+lic = licenses.get(cfg['license'].lower(), (cfg['license'], None))
+dev_requirements = (cfg.get('dev_requirements') or '').split()
+
+package_data = dict()
+pkg_data = cfg.get('package_data', None)
+if pkg_data:
+    package_data[cfg['lib_name']] =  pkg_data.split() # split as multiple files might be listed
+# Add package data to setup_cfg for setuptools.setup(..., **setup_cfg)
+setup_cfg['package_data'] = package_data
+
+setuptools.setup(
+    name = cfg['lib_name'],
+    license = lic[0],
+    classifiers = [
+        'Development Status :: ' + statuses[int(cfg['status'])],
+        'Intended Audience :: ' + cfg['audience'].title(),
+        'Natural Language :: ' + cfg['language'].title(),
+    ] + ['Programming Language :: Python :: '+o for o in py_versions[py_versions.index(min_python):]] + (['License :: ' + lic[1] ] if lic[1] else []),
+    url = cfg['git_url'],
+    packages = setuptools.find_packages(),
+    include_package_data = True,
+    install_requires = requirements,
+    extras_require={ 'dev': dev_requirements },
+    dependency_links = cfg.get('dep_links','').split(),
+    python_requires  = '>=' + cfg['min_python'],
+    long_description = open('README.md', encoding='utf-8').read(),
+    long_description_content_type = 'text/markdown',
+    zip_safe = False,
+    entry_points = {
+        'console_scripts': cfg.get('console_scripts','').split(),
+        'nbdev': [f'{cfg.get("lib_path")}={cfg.get("lib_path")}._modidx:d']
+    },
+    **setup_cfg)
+
+

shell_sage-0.0.1/shell_sage/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.1"

shell_sage-0.0.1/shell_sage/_modidx.py

@@ -0,0 +1,10 @@
+# Autogenerated by nbdev
+
+d = { 'settings': { 'branch': 'main',
+                'doc_baseurl': '/shell_sage',
+                'doc_host': 'https://AnswerDotAI.github.io',
+                'git_url': 'https://github.com/AnswerDotAI/shell_sage',
+                'lib_path': 'shell_sage'},
+  'syms': { 'shell_sage.core': { 'shell_sage.core.get_history': ('core.html#get_history', 'shell_sage/core.py'),
+                                 'shell_sage.core.main': ('core.html#main', 'shell_sage/core.py'),
+                                 'shell_sage.core.run_cmd': ('core.html#run_cmd', 'shell_sage/core.py')}}}

shell_sage-0.0.1/shell_sage/core.py

@@ -0,0 +1,155 @@
+# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/00_core.ipynb.
+
+# %% auto 0
+__all__ = ['print', 'sp', 'model', 'cli', 'ss', 'action_sp', 'chat', 'ssa', 'get_history', 'run_cmd', 'main']
+
+# %% ../nbs/00_core.ipynb 3
+from claudette import *
+from fastcore.script import *
+from fastcore.utils import *
+from functools import partial
+from rich.console import Console
+from rich.markdown import Markdown
+
+import subprocess,sys
+
+# %% ../nbs/00_core.ipynb 4
+print = Console().print
+
+# %% ../nbs/00_core.ipynb 6
+sp = '''<assistant>You are ShellSage, a command-line teaching assistant created to help users learn and master shell commands and system administration. Your knowledge is current as of April 2024.</assistant>
+
+<rules>
+- Receive queries that may include file contents or command output as context
+- Maintain a concise, educational tone
+- Focus on teaching while solving immediate problems
+</rules>
+
+<response_format>
+1. For direct command queries:
+   - Start with the exact command needed
+   - Provide a brief, clear explanation
+   - Show practical examples
+   - Mention relevant documentation
+
+2. For queries with context:
+   - Analyze the provided content first
+   - Address the specific question about that content
+   - Suggest relevant commands or actions
+   - Explain your reasoning briefly
+</response_format>
+
+<style>
+- Use Markdown formatting in your responses
+- Format commands in `backticks`
+- Include comments with # for complex commands
+- Keep responses under 10 lines unless complexity requires more
+- Use bold **text** only for warnings about dangerous operations
+- Break down complex solutions into clear steps
+</style>
+
+<important>
+- Always warn about destructive operations
+- Note when commands require special permissions (e.g., sudo)
+- Link to documentation with `man command_name` or `-h`/`--help`
+</important>'''
+
+# %% ../nbs/00_core.ipynb 7
+model = models[1]
+cli = Client(model)
+ss = partial(cli, sp=sp)
+
+# %% ../nbs/00_core.ipynb 8
+action_sp = '''<assistant>You are ShellSage in Action Mode - an automated command execution assistant. You create and execute plans for bash commands and system administration tasks.</assistant>
+
+<rules>
+- Always start with a clear plan overview
+- Proceed step-by-step, waiting for confirmation
+- Analyze command outputs before proceeding
+- Maximum 3 retry attempts per step
+- Track successful commands for final script generation
+</rules>
+
+<response_format>
+1. Initial Plan Response:
+   ```
+   Plan: <brief overview>
+   Steps:
+   1. <step description>
+      Command: `<command>`
+   2. ...
+   ```
+
+2. Per-Step Response:
+   ```
+   Step N: description of the step and any warnings that could happen if ran
+   Command: `<command>`
+   ```
+
+3. Error Response:
+   ```
+   Error Analysis: description of what went wrong and suggestion for how to fix
+   Command: `<modified command>`
+   ```
+</response_format>
+
+<important>
+- Never execute destructive commands without explicit warning
+- Always validate paths and resources exist before operations
+- In dry-run mode, prefix explanations with "SIMULATION: "
+- Track successful commands for final script generation
+- Always using use markdown for your response
+- Stick to the above format. Do not include any additional text such as asking the user to proceed
+</important>'''
+
+# %% ../nbs/00_core.ipynb 9
+chat = Chat(model, sp=action_sp)
+ssa = chat.toolloop
+
+# %% ../nbs/00_core.ipynb 11
+def get_history(n):
+    try: return subprocess.check_output(['tmux', 'capture-pane', '-p', '-S', f'-{n}'], text=True)
+    except subprocess.CalledProcessError: return None
+
+# %% ../nbs/00_core.ipynb 12
+def run_cmd(
+    desc:str, # description of 
+    cmd:str,  # the command to run
+    ):
+    "Bash command to be ran with the description of why it will be ran and what it will do"
+    
+    print(f"\nStep: {desc}")
+    print(f"Command: `{cmd}`")
+    if input("Proceed? (y/n): ").lower() == 'y':
+        return subprocess.run(cmd, shell=True, text=True, capture_output=True)
+
+# %% ../nbs/00_core.ipynb 13
+#| export
+
+# %% ../nbs/00_core.ipynb 14
+@call_parse
+def main(
+    query: Param('The query to send to the LLM', str, nargs='+'),
+    action: bool = False, # Run ShellSage in action mode
+    NH: bool = False, # Don't include terminal history
+    n: int = 200, # Number of history lines
+    code_theme: str = 'monokai', # The code theme to use when rendering ShellSage's responses
+    code_lexer: str = 'python', # The lexer to use for inline code markdown blocks
+):
+    md = partial(Markdown, code_theme=code_theme, inline_code_lexer=code_lexer, inline_code_theme=code_theme)
+    query = ' '.join(query)
+    ctxt = ''
+    # Get tmux history if requested and available
+    if not NH:
+        history = get_history(n)
+        if history: ctxt += f'<terminal_history>\n{history}\n</terminal_history>'
+
+    # Read from stdin if available
+    if not sys.stdin.isatty(): ctxt += f'\n<context>\n{sys.stdin.read()}</context>'
+    
+    query = f'{ctxt}\n<query>\n{query}\n</query>'
+    if action:
+        print(md(contents(chat(query))))
+        chat.tools = [run_cmd]
+        print(md(contents(ssa('proceed'))))
+    else: print(md(contents(ss(query))))

shell_sage-0.0.1/shell_sage.egg-info/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.1
+Name: shell_sage
+Version: 0.0.1
+Summary: Your favorite AI buddy right in your terminal
+Home-page: https://github.com/AnswerDotAI/shell_sage
+Author: ncoop57
+Author-email: nc@answer.ai
+License: Apache Software License 2.0
+Keywords: nbdev jupyter notebook python
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: Apache Software License
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: claudette
+Requires-Dist: fastcore
+Requires-Dist: rich
+Provides-Extra: dev
+
+# ShellSage
+
+## Usage
+
+### Installation
+
+Install latest from the GitHub
+[repository](https://github.com/AnswerDotAI/shell_sage):
+
+or from [pypi](https://pypi.org/project/shell_sage/)
+
+```sh
+pip install shell_sage
+```
+
+We recommend also setting up your terminal editor of choice to keep the editor content's displayed in the terminal on exit. This allows `ShellSage` to see the files you have been working on. Here is how you can do this in vim:
+
+```sh
+echo "set t_ti= t_te=" >> ~/.vimrc
+```
+
+## How to use
+
+`ShellSage` is designed to be ran inside a tmux session since it relies on tmux for getting what has is displayed on your terminal as context. If you don't want to use tmux, you will need to use the `--NH` command, which will not include your terminal history.
+
+```sh
+ssage hi ShellSage
+```
+
+```markdown
+Hello! I'm ShellSage, your command-line assistant. I can help you with:
+
+- Bash commands and scripting
+- System administration tasks
+- Git operations
+- File management
+- Process handling
+- And more!
+```
+
+You can also pipe outputs into `ShellSage`:
+
+```sh
+cat file.txt | ssage summarize this file
+```

shell_sage-0.0.1/shell_sage.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+settings.ini
+setup.py
+shell_sage/__init__.py
+shell_sage/_modidx.py
+shell_sage/core.py
+shell_sage.egg-info/PKG-INFO
+shell_sage.egg-info/SOURCES.txt
+shell_sage.egg-info/dependency_links.txt
+shell_sage.egg-info/entry_points.txt
+shell_sage.egg-info/not-zip-safe
+shell_sage.egg-info/requires.txt
+shell_sage.egg-info/top_level.txt

shell_sage-0.0.1/shell_sage.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

shell_sage-0.0.1/shell_sage.egg-info/entry_points.txt

@@ -0,0 +1,5 @@
+[console_scripts]
+ssage = shell_sage.core:main
+
+[nbdev]
+shell_sage = shell_sage._modidx:d

shell_sage-0.0.1/shell_sage.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

shell_sage-0.0.1/shell_sage.egg-info/requires.txt

@@ -0,0 +1,5 @@
+claudette
+fastcore
+rich
+
+[dev]

shell_sage-0.0.1/shell_sage.egg-info/top_level.txt

@@ -0,0 +1 @@
+shell_sage