Skip to content

Commit

Permalink
Quicker Start!
Browse files Browse the repository at this point in the history
  • Loading branch information
Josh-XT committed Jun 11, 2023
1 parent 6f1517d commit 2d45074
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 53 deletions.
30 changes: 0 additions & 30 deletions docs/1-Getting started/Quick Start.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
## Quick Start Guide
You have two options for running AGiXT currently, you can either run it with Python locally or you can run it with Docker.

### Local Quick Start Guide
To get started quickly locally, you will need at least Python 3.10.6 installed. If using Windows, we recommend installing [Windows Subsystem For Linux](https://learn.microsoft.com/en-us/windows/wsl/install) first.

Open a terminal and run the following commands:
Expand All @@ -16,31 +14,3 @@ Follow the prompts to install the required dependencies. Any time you want to r

- Access the web interface at http://localhost:8501
- Access the AGiXT API documentation at http://localhost:7437

### Docker Quick Start Guide
To get started quickly with Docker, you will need at least Docker 24.0.2 installed. You can check your version by running `docker --version` in a terminal. You can install Docker by following the instructions [here](https://docs.docker.com/get-docker/).

#### Pull from remote Docker Hub
Open a terminal and run the following commands:
```
git clone https://github.com/Josh-XT/AGiXT
cd AGiXT
docker-compose up
```

- Access the web interface at http://localhost:8501
- Access the AGiXT API documentation at http://localhost:7437
#### Build from Local Dockerfile
Open a terminal and run the following commands:
```
DOCKER_BUILDKIT=1 sudo -E docker-compose -f docker-compose.dev.yaml up
```

- Access the web interface at http://localhost:8501
- Access the AGiXT API documentation at http://localhost:7437

#### Update Docker Containers

```
docker compose pull
```
23 changes: 0 additions & 23 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,6 @@ Embracing the spirit of extremity in every facet of life, we introduce AGiXT. Th
- [Under Development!](#under-development)
- [Key Features 🗝️](#key-features-️)
- [Quick Start Guide](#quick-start-guide)
- [Local Quick Start Guide](#local-quick-start-guide)
- [Docker Quick Start Guide](#docker-quick-start-guide)
- [Update Docker Containers](#update-docker-containers)
- [Configuration](#configuration)
- [Documentation](#documentation)
- [Contributing](#contributing)
Expand Down Expand Up @@ -60,9 +57,7 @@ This project is under active development and may still have issues. We appreciat
- **Expanding AI Support**: Continually updated to include new AI providers and services, ensuring the software stays at the forefront of AI technology.

## Quick Start Guide
You have two options for running AGiXT currently, you can either run it with Python locally or you can run it with Docker.

### Local Quick Start Guide
To get started quickly locally, you will need at least Python 3.10.6 installed. If using Windows, we recommend installing [Windows Subsystem For Linux](https://learn.microsoft.com/en-us/windows/wsl/install) first.

Open a terminal and run the following commands:
Expand All @@ -78,24 +73,6 @@ Follow the prompts to install the required dependencies. Any time you want to r
- Access the web interface at http://localhost:8501
- Access the AGiXT API documentation at http://localhost:7437

### Docker Quick Start Guide
To get started quickly with Docker, you will need at least Docker 24.0.2 installed. You can check your version by running `docker --version` in a terminal. You can install Docker by following the instructions [here](https://docs.docker.com/get-docker/).

Open a terminal and run the following commands:
```
git clone https://github.com/Josh-XT/AGiXT
cd AGiXT
docker-compose up
```

- Access the web interface at http://localhost:8501
- Access the AGiXT API documentation at http://localhost:7437
#### Update Docker Containers

```
docker compose pull
```

## Configuration

Each AGiXT Agent has its own settings for interfacing with AI providers, and other configuration options. These settings can be set and modified through the web interface.
Expand Down

0 comments on commit 2d45074

Please sign in to comment.