Initial Home page

sawka 2023-08-09 22:56:21 -07:00
commit e99c745141

54
Home.md Normal file

@ -0,0 +1,54 @@
# Build Instructions for Prompt Client
## Prereqs and Tools
Download and install Go (must be at least go 1.18):
```
brew install go
```
Download and install ScriptHaus (to run the build commands):
```
brew tap scripthaus-dev/scripthaus
brew install scripthaus
```
## Repositories
Create a work directory (where all the repos will be located). Note do *not* use ~/prompt or ~/prompt-dev (as these directories are used by the actual prompt app). I use ~/work/prompt-dev.
Clone these 3 prompt repositories into your work directory:
```
git clone git@github.com:commandlinedev/prompt-client.git
git clone git@github.com:commandlinedev/prompt-server.git
git clone git@github.com:commandlinedev/apishell.git
```
## Building API Shell
```
# must be run from the apishell directory
scripthaus run fullbuild
```
This will create a "bin" directory in your apishell directory. There should be 4 binaries built: mshell-v0.2-{darwin,linux}.{amd64,arm64}.
## Building Prompt Server
Prompt Server depends on APIShell to build. Because APIShell is held in a private repository we need to set up a go workspace so go will not try to download apishell directly (it will fail because the module url is not public).
In your work directory (not in the prompt-server subdirectory), create a file called go.work with this content:
```
go 1.18
use (
./apishell
./prompt-server
)
```
Now, cd to the prompt-server directory and run:
```
scripthaus run build
```