Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

extending readme #5

Closed
wants to merge 1 commit into from
Closed

extending readme #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,48 @@ aicli
## Example

https://github.com/samuelcolvin/aicli/assets/4039449/15cc8127-c5fc-4cff-a9d7-3560f3b96d60


## Local Installation
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I agree with this.

In general, if you have experience with python libraries, contributing should be pretty straight forward.

For general use you should install with pip install samuelcolvin-aicli.


Follow these steps to install the project locally

## Step 1: Clone the Repository

First, clone the repository to your local machine. You can do this by running the following command in your terminal:

```bash
git clone https://github.com/samuelcolvin/aicli.git
```

## Step 2: Install Python

The project requires Python 3.7 or higher. If you don't have Python installed, you can download it from the official website:

```bash
https://www.python.org/downloads/
```

## Step 3: Install Dependencies

Navigate to the project directory and install the required dependencies. The dependencies are listed in the `requirements/linting.txt` file and `pyproject.toml` file. You can install them using pip:

```bash
pip install -r requirements/linting.txt
```

The project also requires the following packages: `openai`, `rich`, and `prompt-toolkit`. You can install them using pip:

```bash
pip install openai rich prompt-toolkit
```

## Step 4: Run the Project

Finally, you can run the project using the provided script `aicli`:

```bash
python samuelcolvin_aicli.py
```

You should now have a functioning installation of the project.
Loading