Skip to content

Issue 7799 - Move section on building environment tool to developer guide #7847

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

Merged
patchwork01 merged 1 commit into from
Aug 4, 2026
+2 −6
Merged

Issue 7799 - Move section on building environment tool to developer guide #7847

Show file tree
Hide file tree
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
6 changes: 0 additions & 6 deletions docs/deployment/environment-tool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,6 @@ once in a given AWS account. Use your account number and region in the command b
sleeper cdk bootstrap aws://<account>/<region>
```

### Rebuild environment

If the environment configuration code has been changed it will need to be rebuilt before deployment.
Ensure you are working on the branch that contains the changes and execute ```scripts/cli/environment/buildWithDependencies.sh```
Once complete you can proceed to deploying an environment.

### Deploy/connect to an environment

The Sleeper environment tool can create a machine in AWS to deploy Sleeper from (an EC2 instance) and a networking
Expand Down
2 changes: 2 additions & 0 deletions docs/developer-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ To build the Sleeper Docker tools, you can run this script:
./scripts/cli/buildAll.sh
```

There are also scripts to build individual tools, like `scripts/cli/environment/buildWithDependencies.sh`.

Use `./scripts/cli/runInDocker.sh` to run the built CLI. This will act the same as running the `sleeper`
command after installing the CLI. You can manually install it if you copy that script somewhere, rename it to `sleeper`,
and put it on the system path. Then `sleeper ...` commands will work as though you'd installed it normally.
Expand Down