Skip to content

Commit

Permalink
Add windows instructions (#533)
Browse files Browse the repository at this point in the history
Also add links to the instructions from the root README.md
  • Loading branch information
curtisman authored Jan 8, 2025
1 parent 3088d19 commit c6172f1
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 5 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The TypeAgent repo contains the personal agent and example application agents, a

- [Agent Dispatcher](./ts/packages/dispatcher/)

Explores applying TypeChat to route user requests to agents whose typed contract best matches user intent. Main component of the personal agent.
Explores applying TypeChat to route user requests to agents whose typed contract best matches user intent. Main component of the personal agent.

- [Agent Cache](./ts/packages/cache/)

Expand Down Expand Up @@ -61,9 +61,18 @@ TypeAgent is early stage sample code over TypeChat. TypeAgent is not a framework

TypeAgent is written in TypeScript and relies on TypeChat. To understand how TypeAgent examples work, we recommend getting comfortable with TypeChat and [TypeChat examples](https://github.com/microsoft/TypeChat/tree/main/typescript/examples) first.

### Agent Shell Example
### Quick start - Agent Shell Example

The main entry point to explore TypeAgent is the Agent Shell example. Follow the [instructions](./ts/README.md) in the TypeScript code [directory](./ts) to get started.
The main entry point to explore TypeAgent is the [Agent Shell](./ts/packages/shell) example.

Follow these quick starts for step-by-step instructions to quickly setup tools and environments from scratch to build, run and develop.

- [Windows](./docs/setup/setup-Windows.md)
- [WSL2](./docs/setup/setup-WSL2.md)
- Linux (coming soon)
- MacOS (coming soon)

See the [instructions](./ts/README.md) in the TypeScript code [directory](./ts) for more detailed setup instructions.

## Developers

Expand Down
4 changes: 2 additions & 2 deletions docs/setup/setup-WSL2.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# WSL2 environment setup

This is a list of step-by-step instructions to set up a WSL2 environment from _scratch_ to build, run, and develop the TypeAgent repo, collated from various READMEs throughout the repo and external source. Links to the original instructions for each part are provided for reference, but mostly not required to visit if you just follow the instructions here. Modified the steps as necessary to suit your needs.
This is a list of step-by-step instructions to set up a WSL2 environment from _scratch_ to build, run, and develop the TypeAgent repo, collated from various READMEs throughout the repo and external source. The instruction will install and setup the necessary tools and put the repo in `~/src/TypeAgent`. Links to the original instructions for each part are provided for reference, but mostly not required to visit if you just follow the instructions here. Skip or change the steps as necessary to suit your needs.

## Build

Expand Down Expand Up @@ -53,4 +53,4 @@ This is a list of step-by-step instructions to set up a WSL2 environment from _s
- Install VSCode on Windows ([download](https://code.visualstudio.com/download))
- Install VSCode extension [Remote Development](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack)
- Start VSCode in WSL (_Continued from above command prompt in WSL_)
- `code .`
- `code ~/src/TypeAgent/ts`
31 changes: 31 additions & 0 deletions docs/setup/setup-Windows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Windows environment setup

This is a list of step-by-step instructions to set up a Windows environment from _scratch_ to build, run, and develop the TypeAgent repo, collated from various READMEs throughout the repo and external source. The instruction will install and setup the necessary tools and put the repo in C:\src\TypeAgent. Links to the original instructions for each part are provided for reference, but mostly not required to visit if you just follow the instructions here. Skip or change the steps as necessary to suit your needs.

## Build

- Install Git ([download](https://git-scm.com/downloads/win))
- Install Node ([download](https://nodejs.org/en/download))
- Enable corepack
- Open Command Prompt as Administrator
- `corepack enable`
- Clone and build:
- Open command prompt
- `git clone https://github.com/microsoft/TypeAgent C:\src\TypeAgent`
- `cd /d C:\src\TypeAgent\ts`
- `pnpm setup`
- `pnpm i`
- `pnpm run build`

## Run

- Setup Service Keys (See instructions [here](./../../ts/README.md#service-keys))
- Run the TypeAgent shell
- `pnpm run shell`

## Development

- Install VSCode ([download](https://code.visualstudio.com/download))
- Start VSCode
- Open command prompt
- `code C:\src\TypeAgent\ts`

0 comments on commit c6172f1

Please sign in to comment.