bonyuta0204 / ecs-nav

ECS Navigator (ecs-nav)

ECS Navigator (ecs-nav) is a Rust-based CLI tool designed to simplify the use of ecs-exec in Amazon ECS. This tool allows you to interactively select ECS clusters, services, and tasks to execute commands within containers.

Features

• List ECS clusters interactively.
• Select an ECS cluster and list services within it.
• Select a service and list tasks within it.
• Execute commands in containers interactively.

Installation

Using cargo install from GitHub

To install ecs-nav using cargo install from GitHub, you need to have Rust installed on your machine. If you don't have Rust installed, you can get it from rust-lang.org.

1. Install ecs-nav:

   cargo install --git https://github.com/bonyuta0204/ecs-nav.git

From Source

To install ecs-nav from source, you need to have Rust installed on your machine. If you don't have Rust installed, you can get it from rust-lang.org.

1. Clone the repository:

   git clone https://github.com/bonyuta0204/ecs-nav.git
   cd ecs-nav

2. Build the project:

   cargo build --release

3. Run the project:

   ./target/release/ecs-nav

From Binary

1. Download the binary from the Release page.

2. Put the binary file in a directory that is included in your $PATH.

3. You can now start using ecs-nav by running:

   ecs-nav

System Requirements

• AWS CLI
• AWS Session Manager installed

Usage

1. Run the ecs-nav command:

   ecs-nav

2. Follow the prompts to select a cluster, service, and task.

3. Execute the desired command in the container.

Configuration

Ensure you have AWS credentials configured on your machine. You can set them up using the AWS CLI:

aws configure

Developer Notes

• This project uses the AWS SDK for Rust to interact with Amazon ECS.
• The dialoguer crate is used for interactive command-line prompts.
• The project structure is simple, with the main logic contained in src/main.rs and AWS client configuration in src/aws_client.rs.
• Feel free to expand the functionality by adding more features or improving existing ones.
• If you encounter any issues or have suggestions, please open an issue or a pull request on the repository.

Contributing

Contributions are welcome! Please fork the repository and submit pull requests.

ecs-nav's Issues

Automated Release

reference

https://github.com/sharkdp/bat/blob/master/.github/workflows/CICD.yml