Lilith Shell

🚀 Lilith-shell Project Introduction

Lilith-shell is a powerful tool that enables users to execute commands in a custom shell environment within Claude Desktop. It is a forked version of Pandora-shell, with numerous enhancements in terms of security, testability, and functionality.

🚀 Quick Start

✨ Features

• Execute commands in a custom shell environment within Claude Desktop.
• Enhanced security, testability, and functionality compared to Pandora-shell.

📦 Installation

Project Cloning and Dependency Installation

1. Clone the project repository:

   git clone https://github.com/yourusername/Lilith-Shell.git
   cd Lilith-Shell
   

2. Create and activate a virtual environment (recommended):
   • For macOS/Linux systems:

     python -m venv venv
     source venv/bin/activate
     

   • For Windows systems:

     python -m venv venv
     .\venv\Scripts\activate
     

3. Install the dependencies:

   pip install -r requirements.txt
   

Configuration Guide

Project Path Setup

Ensure that you add the full path of the Lilith-Shell project to the system's environment variables.

Environment Variable Configuration

Edit or create the following files based on your operating system:

Windows Systems

1. Open System Environment Variables.
2. Add or modify the following variables:
   • Path: Add %APPDATA%\Lilith-Shell\bin to the system path.

macOS/Linux Systems

1. Open the terminal and edit the .bashrc or .zshrc file:

   nano ~/.bashrc
   

2. Add the following content to the end of the file:

   export PATH=$PATH:/path/to/Lilith-Shell/bin
   

3. Save and exit, then run source ~/.bashrc to make the configuration take effect.

💻 Usage Examples

Basic Usage

Starting the Service

Start the Lilith-shell service in the project's root directory:

# For macOS/Linux systems:
python src/lilith_shell/executor.py

# For Windows systems:
.\venv\Scripts\python.exe src\lilith_shell\executor.py

Example Commands

1. Query the current working directory:

   Can you run 'pwd' and tell me what directory we're in?
   

2. List the files in the user's home directory and filter out files larger than 200 MB:

   Can you list the files in my home directory? Which of them are larger than 200 MB?
   

⚠️ Important Note

Lilith-shell executes commands with the user's permissions. For security reasons, please follow these suggestions:

1. Use only in trusted environments:
   • Use a virtual machine (VM) or a disposable development environment.
   • Do not use it on production systems or devices storing sensitive data.
2. Implement command restrictions:
   • Configure a whitelist policy to allow the execution of specific commands.
   • Regularly review and update the list of allowed commands.
3. Monitor system activities:
   • Use system monitoring tools to track user activities.
   • Regularly audit log files to detect abnormal behavior.
4. Back up data:
   • Regularly back up important data in case of unexpected situations.

Troubleshooting

Service Startup Failure

1. Check if any other processes are occupying the same port.
2. View the error log for more information:

   tail -f logs/error.log
   

Network Connection Issues

1. Ensure that the firewall rules allow communication on the relevant ports.
2. Check the network configuration to ensure that the service can access the Internet.

Acknowledgments and References

• Pandora-shell: The base project of Lilith-shell, which provides many core functions and code implementations.
• Python Official Documentation: Used to understand relevant knowledge about virtual environments and dependency management.
• Community and Technical Forums: Thanks to the technical support and discussions from the open-source community.

By following the above steps, you can smoothly use the Lilith-shell project and customize and expand it according to your specific needs. If you have any questions or suggestions, please feel free to contact the project maintainers.