leeway
Leeway is a heavily caching build system for Go, Typescript and Docker projects.
File Explorer
- devcontainer.json
- Dockerfile
- pre-commit
- ci-build.yaml
- integration-tests.yaml
- release.yaml
- automations.yaml
- launch.json
- settings.json
- bashCompletion.go
- build.go
- build_test.go
- collect.go
- describe-changed.go
- describe-const.go
- describe-dependants.go
- describe-dependencies.go
- describe-environment-manifest.go
- describe-gitinfo.go
- describe-manifest.go
- describe-script.go
- describe-tree.go
- describe.go
- exec.go
- experimental-mount.go
- experimental-unmount.go
- export.go
- fmt.go
- init.go
- link.go
- plumbing-exec.go
- plumbing.go
- provenance-assert.go
- provenance-export.go
- provenance.go
- root.go
- run.go
- sbom-export.go
- sbom-scan.go
- sbom.go
- sign-cache.go
- sign-cache_test.go
- version.go
- vet.go
- observability.md
- doublestar.go
- doublestar_test.go
- fs.go
- fs_test.go
- gsutil.go
- no_cache.go
- no_cache_test.go
- s3.go
- s3_config_test.go
- s3_download_test.go
- s3_performance_test.go
- s3_provenance_test.go
- s3_resilience_test.go
- s3_slsa_test.go
- s3_test.go
- mock_verifier.go
- README.md
- verifier.go
- verifier_test.go
- mock.go
- types.go
- load-workspace.yaml
- attestation.go
- attestation_test.go
- errors.go
- errors_test.go
- rekor.go
- rekor_test.go
- upload.go
- upload_test.go
- tracer.go
- tracer_test.go
- build.go
- build_checksum_test.go
- build_darwin.go
- build_integration_test.go
- build_internal_test.go
- build_linux.go
- build_oci_test.go
- build_sort_test.go
- build_test.go
- build_validate_deps_test.go
- compression.go
- compression_test.go
- container_image.go
- export.go
- format.go
- format_test.go
- gitinfo.go
- gitinfo_test.go
- gotest_trace.go
- gotest_trace_test.go
- package.go
- package_test.go
- provenance.go
- provenance_test.go
- reporter.go
- reporter_otel_phase_test.go
- reporter_otel_test.go
- reporter_test.go
- sbom-scan.go
- sbom.go
- sbom_normalize_test.go
- sbom_scan_test.go
- sbom_test.go
- scripts.go
- scripts_test.go
- version.go
- watcher.go
- workspace.go
- workspace_test.go
- golang.go
- yarn.go
- prettyprint.go
- access.go
- assert.go
- testutil.go
- testutil_test.go
- components.go
- docker.go
- docker_test.go
- generic.go
- golang.go
- packages.go
- vet.go
- yarn.go
- .gitignore
- .goreleaser.yaml
- BUILD.yaml
- codecov.yml
- go.mod
- go.sum
- LICENSE
- logo.png
- main.go
- README.md
- WORKSPACE.yaml
# Use via CDN
jsDelivrjsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.
Command Glossary
Commands referenced in this DOCs, explained below.
AWS
View Details ▼
AWS
The official CLI tool for Amazon Web Services.
Some subcommands such as `s3` have their own usage documentation.
aws configure wizard
Configure the AWS Command-line:
aws configure sso
Configure the AWS Command-line using SSO:
aws sts get-caller-identity
Get the caller identity (used to troubleshoot permissions):
brew install
View Details ▼
brew install
Install a Homebrew formula or cask.
brew install {{formula|cask}}
Install a formula/cask:
brew install {{[-s|--build-from-source]}} {{formula}}
Build and install a formula from source (dependencies will still be installed from bottles):
brew install {{[-n|--dry-run]}} {{formula|cask}}
Download the manifest, print what would be installed but don't actually install anything:
docker buildx create
View Details ▼
docker buildx create
Create a new builder instance.
docker buildx create
Create a new builder instance using the default Docker context:
docker buildx create --name {{builder_name}}
Create a new builder instance with a specific name:
docker buildx create --name {{builder_name}} --use
Create a new builder instance and immediately set it as the current active builder:
docker load
View Details ▼
docker load
This command is an alias of `docker image load`.
tldr docker image load
View documentation for the original command:
docker save
View Details ▼
docker save
This command is an alias of `docker image save`.
tldr docker image save
View documentation for the original command:
docker
View Details ▼
docker
Manage Docker containers and images.
Some subcommands such as `container` and `image` have their own usage documentation.
docker {{[ps|container ls]}} {{[-a|--all]}}
List all Docker containers (running and stopped):
docker {{[run|container run]}} --name {{container_name}} {{image}}
Start a container from an image, with a custom name:
docker container {{start|stop}} {{container_name}}
Start or stop an existing container:
git push
View Details ▼
git push
Push commits to a remote repository.
git push
Send local changes in the current branch to its default remote counterpart:
git push {{remote_name}} {{local_branch}}
Send changes from a specific local branch to its remote counterpart:
git push {{[-u|--set-upstream]}} {{remote_name}} {{local_branch}}
Send changes from a specific local branch to its remote counterpart, and set the remote one as the default push/pull target of the local one:
git tag
View Details ▼
git tag
Create, list, delete, or verify tags.
A tag is a static reference to a commit.
git tag
List all tags:
git tag {{tag_name}}
Create a tag with the given name pointing to the current commit:
git tag {{tag_name}} {{commit}}
Create a tag with the given name pointing to a given commit:
go build
View Details ▼
go build
Compile Go sources.
go build {{path/to/main.go}}
Compile a 'package main' file (output will be the filename without extension):
go build -o {{path/to/binary}} {{path/to/source.go}}
Compile, specifying the output filename:
go build -o {{path/to/binary}} {{path/to/package}}
Compile a package:
go fmt
View Details ▼
go fmt
Format Go source files, printing the changed filenames.
Note: `./...` is a Go package pattern understood by Go tooling. It matches the current package and all packages recursively under the current directory.
go fmt
Format Go source files in the current directory:
go fmt {{path/to/package}}
Format a specific Go package in your import path (`$GOPATH/src`):
go fmt {{./...}}
Format the package in the current directory and all subdirectories (note the `...`):
go generate
View Details ▼
go generate
Generate Go files by running commands within source files.
go generate
Generate Go files by running commands within source files:
go test
View Details ▼
go test
Test Go packages (files have to end with `_test.go`).
Note: `./...` is a Go package pattern understood by Go tooling. It matches the current package and all packages recursively under the current directory.
go test
Test the package found in the current directory:
go test -v
[v]erbosely test the package in the current directory:
go test -v ./...
Test the packages in the current directory and all subdirectories:
go version
View Details ▼
go version
Display Go version.
go version
Display version:
go version {{path/to/executable}}
Display the Go version used to build a specific executable file:
yarn
View Details ▼
yarn
JavaScript and Node.js package manager alternative.
yarn global add {{module_name}}
Install a module globally:
yarn install
Install all dependencies referenced in the `package.json` file (the `install` is optional):
yarn add {{module_name}}@{{version}}
Install a module and save it as a dependency to the `package.json` file (add `--dev` to save as a dev dependency):
GCP
View Details ▼
GCP
This command is an alias of GNU `cp`.
tldr cp
View documentation for the original command: