Skip to content

Commit

Permalink
docs: added cli access instructions (Sinaptik-AI#206)
Browse files Browse the repository at this point in the history
  • Loading branch information
sandiemann authored Jun 1, 2023
1 parent 4d0f981 commit 55178f8
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 2 deletions.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,20 @@ You can find more examples in the [examples](examples) directory.

## Command-Line Tool

Pai is the command line tool designed to provide a convenient way to interact with PandasAI through a command line interface (CLI).
Pai is the command line tool designed to provide a convenient way to interact with PandasAI through a command line interface (CLI). In order to access the CLI tool, make sure to create a virtualenv for testing purpose and to install project dependencies in your local virtual environment using `pip` by running the following command:
```
pip install -e .
```
Alternatively, you can use `poetry` to create and activate the virtual environment by running the following command:
```
poetry shell
```
Inside the activated virtual environment, install the project dependencies by running the following command:
```
poetry install
```

By following these steps, you will now have the necessary environment to access the CLI tool.

```
pai [OPTIONS]
Expand Down
15 changes: 14 additions & 1 deletion docs/pai_cli.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
# Command-Line Tool
[Pai] is the command line tool designed to provide a convenient way to interact with `pandasai` through a command line interface (CLI).
[Pai] is the command line tool designed to provide a convenient way to interact with `pandasai` through a command line interface (CLI). In order to access the CLI tool, make sure to create a virtualenv for testing purpose and to install project dependencies in your local virtual environment using `pip` by running the following command:
```
pip install -e .
```
Alternatively, you can use `poetry` to create and activate the virtual environment by running the following command:
```
poetry shell
```
Inside the activated virtual environment, install the project dependencies by running the following command:
```
poetry install
```

By following these steps, you will now have the necessary environment to access the CLI tool.

```
pai [OPTIONS]
Expand Down

0 comments on commit 55178f8

Please sign in to comment.