Sha256: c82f76479afe2ed5bf996d020b0d52cad4aa335d8a5e7fb4b075d50543ec7a38

Contents?: true

Size: 1.18 KB

Versions: 1

Compression:

Stored size: 1.18 KB

Contents

---
title: Quick Start
---

In a hurry? No sweat! Here's a quick overview of how to use sonic.

### Install

```sh
gem install sonic-screwdriver
```

### Usage

```sh
# ssh into an instance
sonic ssh i-0f7f833131a51ce35
sonic ssh hi-web-stag # ec2 tag
sonic ssh hi-web-stag --cluster stag # ecs service name
sonic ssh hi-web-stag --cluster stag  # ecs service name
sonic ssh 7fbc8c75-4675-4d39-a5a4-0395ff8cd474 --cluster stag  # ECS container id
sonic ssh 1ed12abd-645c-4a05-9acf-739b9d790170 --cluster stag  # ECS task id

# docker exec to a running ECS docker container
sonic ecs-exec hi-web-stag

# docker run with same environment as the ECS docker running containers
sonic ecs-run hi-web-stag

# run command on 1 instance
sonic execute i-0f7f833131a51ce35 uptime

# run command on all instances tagged with hi-web-stag and worker
sonic execute hi-web-stag,hi-worker-stag uptime

# list ec2 instances
sonic list hi-web-stag
```

Congratulations! You now know the basic sonic screwdriver commands now.

Learn more in the next sections.

<a id="next" class="btn btn-primary" href="{% link docs.md %}">Next Step</a>
<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
sonic-screwdriver-1.4.0 docs/quick-start.md