copilot-cli

module

v1.16.0 Latest Latest Go to latest Published: Apr 5, 2022 License: Apache-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/aws/copilot-cli

Links

Open Source Insights

README ¶

AWS Copilot CLI

Build, Release and Operate Containerized Applications on AWS.

latest version

Documentation: https://aws.github.io/copilot-cli/

The AWS Copilot CLI is a tool for developers to build, release and operate production ready containerized applications on AWS App Runner, Amazon ECS, and AWS Fargate.

Use Copilot to:

Deploy production-ready, scalable services on AWS from a Dockerfile in one command.
Add databases or inject secrets to your services.
Grow from one microservice to a collection of related microservices in an application.
Set up test and production environments, across regions and accounts.
Set up CI/CD pipelines to release your services to your environments.
Monitor and debug your services from your terminal.

init

Installation

To install with homebrew:

$ brew install aws/tap/copilot-cli

To install manually, we're distributing binaries from our GitHub releases:

Instructions for installing Copilot for your platform

Platform	Command to install
macOS	`curl -Lo copilot https://github.com/aws/copilot-cli/releases/latest/download/copilot-darwin && chmod +x copilot && sudo mv copilot /usr/local/bin/copilot && copilot --help`
Linux x86 (64-bit)	`curl -Lo copilot https://github.com/aws/copilot-cli/releases/latest/download/copilot-linux && chmod +x copilot && sudo mv copilot /usr/local/bin/copilot && copilot --help`
Linux (ARM)	`curl -Lo copilot https://github.com/aws/copilot-cli/releases/latest/download/copilot-linux-arm64 && chmod +x copilot && sudo mv copilot /usr/local/bin/copilot && copilot --help`
Windows	`Invoke-WebRequest -OutFile 'C:\Program Files\copilot.exe' https://github.com/aws/copilot-cli/releases/latest/download/copilot-windows.exe`

Getting started

Make sure you have the AWS command line tool installed and have already run aws configure before you start.

To get a sample app up and running in one command, run the following:

$ git clone git@github.com:aws-samples/aws-copilot-sample-service.git demo-app
$ cd demo-app
$ copilot init --app demo                \
  --name api                             \
  --type 'Load Balanced Web Service'     \
  --dockerfile './Dockerfile'            \
  --deploy

This will create a VPC, Application Load Balancer, an Amazon ECS Service with the sample app running on AWS Fargate. This process will take around 8 minutes to complete - at which point you'll get a URL for your sample app running! 🚀

Learning more

Want to learn more about what's happening? Check out our documentation https://aws.github.io/copilot-cli/ for a getting started guide, learning about Copilot concepts, and a breakdown of our commands.

Feedback

Have any feedback at all? 🙏 Drop us an issue or join us on gitter.

We're happy to hear feedback or answer questions, so reach out, anytime!

Security disclosures

If you think you’ve found a potential security issue, please do not post it in the Issues. Instead, please follow the instructions here or email AWS security directly at aws-security@amazon.com.

License

This library is licensed under the Apache 2.0 License.

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
cmd
copilot Package main contains the root command.	Package main contains the root command.
copilot/template Package template provides usage templates to render help menus.	Package template provides usage templates to render help menus.
e2e
internal/client
internal/command
apprunner/front-end Module
internal
pkg/addon Package addon contains the service to manage addons.	Package addon contains the service to manage addons.
pkg/addon/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/apprunner Package apprunner provides a client to retrieve Copilot App Runner information.	Package apprunner provides a client to retrieve Copilot App Runner information.
pkg/apprunner/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/aws/aas Package aas provides a client to make API requests to Application Auto Scaling.	Package aas provides a client to make API requests to Application Auto Scaling.
pkg/aws/aas/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/aws/apprunner Package apprunner provides a client to make API requests to AppRunner Service.	Package apprunner provides a client to make API requests to AppRunner Service.
pkg/aws/apprunner/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/aws/cloudformation Package cloudformation provides a client to make API requests to AWS CloudFormation.	Package cloudformation provides a client to make API requests to AWS CloudFormation.
pkg/aws/cloudformation/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/aws/cloudformation/stackset Package stackset provides a client to make API requests to an AWS CloudFormation StackSet resource.	Package stackset provides a client to make API requests to an AWS CloudFormation StackSet resource.
pkg/aws/cloudformation/stackset/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/aws/cloudwatch Package cloudwatch provides a client to make API requests to Amazon CloudWatch Service.	Package cloudwatch provides a client to make API requests to Amazon CloudWatch Service.
pkg/aws/cloudwatch/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/aws/cloudwatchlogs Package cloudwatchlogs provides a client to make API requests to Amazon CloudWatch Logs.	Package cloudwatchlogs provides a client to make API requests to Amazon CloudWatch Logs.
pkg/aws/cloudwatchlogs/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/aws/codepipeline Package codepipeline provides a client to make API requests to Amazon Elastic Container Service.	Package codepipeline provides a client to make API requests to Amazon Elastic Container Service.
pkg/aws/codepipeline/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/aws/codestar Package codestar provides a client to make API requests to AWS CodeStar Connections.	Package codestar provides a client to make API requests to AWS CodeStar Connections.
pkg/aws/codestar/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/aws/ec2 Package ec2 provides a client to make API requests to Amazon Elastic Compute Cloud.	Package ec2 provides a client to make API requests to Amazon Elastic Compute Cloud.
pkg/aws/ec2/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/aws/ecr Package ecr provides a client to make API requests to Amazon EC2 Container Registry.	Package ecr provides a client to make API requests to Amazon EC2 Container Registry.
pkg/aws/ecr/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/aws/ecs Package ecs provides a client to make API requests to Amazon Elastic Container Service.	Package ecs provides a client to make API requests to Amazon Elastic Container Service.
pkg/aws/ecs/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/aws/elbv2 Package elbv2 provides a client to make API requests to Amazon Elastic Load Balancing.	Package elbv2 provides a client to make API requests to Amazon Elastic Load Balancing.
pkg/aws/elbv2/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/aws/iam Package iam provides a client to make API requests to the AWS Identity and Access Management service.	Package iam provides a client to make API requests to the AWS Identity and Access Management service.
pkg/aws/iam/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/aws/identity Package identity provides a client to make API requests to AWS Security Token Service.	Package identity provides a client to make API requests to AWS Security Token Service.
pkg/aws/identity/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/aws/partitions
pkg/aws/profile Package profile provides functionality to parse AWS named profiles.	Package profile provides functionality to parse AWS named profiles.
pkg/aws/resourcegroups Package resourcegroups provides a client to make API requests to AWS Resource Groups	Package resourcegroups provides a client to make API requests to AWS Resource Groups
pkg/aws/resourcegroups/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/aws/route53 Package route53 provides functionality to manipulate route53 primitives.	Package route53 provides functionality to manipulate route53 primitives.
pkg/aws/route53/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/aws/s3 Package s3 provides a client to make API requests to Amazon Simple Storage Service.	Package s3 provides a client to make API requests to Amazon Simple Storage Service.
pkg/aws/s3/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/aws/secretsmanager Package secretsmanager provides a client to make API requests to AWS Secrets Manager.	Package secretsmanager provides a client to make API requests to AWS Secrets Manager.
pkg/aws/secretsmanager/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/aws/sessions Package sessions provides functions that return AWS sessions to use in the AWS SDK.	Package sessions provides functions that return AWS sessions to use in the AWS SDK.
pkg/aws/ssm Package ssm provides a client to make API requests to Amazon Systems Manager.	Package ssm provides a client to make API requests to Amazon Systems Manager.
pkg/aws/ssm/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/aws/stepfunctions Package stepfunctions provides a client to make API requests to Amazon Step Functions.	Package stepfunctions provides a client to make API requests to Amazon Step Functions.
pkg/aws/stepfunctions/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/aws/tags Package tags implements simple functions to manipulate AWS resource tags.	Package tags implements simple functions to manipulate AWS resource tags.
pkg/cli Package cli contains the copilot subcommands.	Package cli contains the copilot subcommands.
pkg/cli/deploy Package deploy holds the structures to deploy a workload.	Package deploy holds the structures to deploy a workload.
pkg/cli/deploy/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/cli/group Package group contains the names of command groups.	Package group contains the names of command groups.
pkg/cli/list
pkg/cli/list/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/cli/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/config Package config implements CRUD operations for application, environment, service and pipeline configuration.	Package config implements CRUD operations for application, environment, service and pipeline configuration.
pkg/deploy Package deploy holds the structures to deploy infrastructure resources.	Package deploy holds the structures to deploy infrastructure resources.
pkg/deploy/cloudformation Package cloudformation provides functionality to deploy CLI concepts with AWS CloudFormation.	Package cloudformation provides functionality to deploy CLI concepts with AWS CloudFormation.
pkg/deploy/cloudformation/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/deploy/cloudformation/stack
pkg/deploy/cloudformation/stack/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/deploy/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/describe
pkg/describe/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/describe/stack
pkg/describe/stack/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/docker/dockerengine Package dockerengine provides functionality to interact with the Docker server.	Package dockerengine provides functionality to interact with the Docker server.
pkg/docker/dockerfile Package dockerfile provides functionality to parse a Dockerfile.	Package dockerfile provides functionality to parse a Dockerfile.
pkg/ecs Package ecs provides a client to retrieve Copilot ECS information.	Package ecs provides a client to retrieve Copilot ECS information.
pkg/ecs/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/exec Package exec provides an interface to execute certain commands.	Package exec provides an interface to execute certain commands.
pkg/graph Package graph provides functionality for directed graphs.	Package graph provides functionality for directed graphs.
pkg/ini Package ini provides functionality to parse and read properties from INI files.	Package ini provides functionality to parse and read properties from INI files.
pkg/initialize Package initialize contains methods and structs needed to initialize jobs and services.	Package initialize contains methods and structs needed to initialize jobs and services.
pkg/initialize/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/logging Package logging contains utility functions for ECS logging.	Package logging contains utility functions for ECS logging.
pkg/logging/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/manifest Package manifest provides functionality to create Manifest files.	Package manifest provides functionality to create Manifest files.
pkg/repository Package repository provides support for building and pushing images to a repository.	Package repository provides support for building and pushing images to a repository.
pkg/repository/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/stream Package stream implements streamers that publish AWS events periodically.	Package stream implements streamers that publish AWS events periodically.
pkg/task Package task provides support for running Amazon ECS tasks.	Package task provides support for running Amazon ECS tasks.
pkg/task/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/template Package template renders the static files under the "/templates/" directory.	Package template renders the static files under the "/templates/" directory.
pkg/template/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/template/override Package override provides functionality to replace content from vended templates.	Package override provides functionality to replace content from vended templates.
pkg/term/color Package color provides functionality to displayed colored text on the terminal.	Package color provides functionality to displayed colored text on the terminal.
pkg/term/cursor Package cursor provides functionality to interact with the terminal cursor.	Package cursor provides functionality to interact with the terminal cursor.
pkg/term/log Package log is a wrapper around the fmt package to print messages to the terminal.	Package log is a wrapper around the fmt package to print messages to the terminal.
pkg/term/progress
pkg/term/progress/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/term/progress/summarybar Package summarybar provides renderers for summary bar.	Package summarybar provides renderers for summary bar.
pkg/term/prompt Package prompt provides functionality to retrieve free-form text, selection, and confirmation input from the user via a terminal.	Package prompt provides functionality to retrieve free-form text, selection, and confirmation input from the user via a terminal.
pkg/term/selector Package selector provides functionality for users to select an application, environment, or service name.	Package selector provides functionality for users to select an application, environment, or service name.
pkg/term/selector/mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
pkg/version Package version holds variables for generating version information	Package version holds variables for generating version information
pkg/workspace Package workspace contains functionality to manage a user's local workspace.	Package workspace contains functionality to manage a user's local workspace.