Skip to content

Commit 2e9f396

Browse files
authored
Merge pull request #138 from thin-edge/docs-add-notes-about-go-c8y-cli
docs: add instructions for using go-c8y-cli and c8y-tedge to launch a demo container
2 parents e69bba3 + c70c645 commit 2e9f396

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,41 @@ The following pre-requisites are required before you can get started:
1111

1212
Check out the list of [known working setups](./docs/USER_GUIDE.md#known-working-environments) to see what software you can use for your Operating Systemd to meet the pre-requisites.
1313

14+
## Starting a demo container using go-c8y-cli
15+
16+
If you're a Cumulocity user, then you can use the [Cumulocity CLI tool, go-c8y-cli](https://goc8ycli.netlify.app/) and the thin-edge.io extension for it ([c8y-tedge](https://github.com/thin-edge/c8y-tedge)), to quickly launch demo containers without having to checkout this project.
17+
18+
First, you'll need to install go-c8y-cli (in addition to having docker and docker compose already installed):
19+
20+
* [Install go-c8y-cli](https://goc8ycli.netlify.app/docs/installation/)
21+
22+
Then, install the [c8y-tedge](https://github.com/thin-edge/c8y-tedge) extension:
23+
24+
```sh
25+
c8y extensions install thin-edge/c8y-tedge
26+
27+
# or update it to the latest version
28+
c8y extensions update tedge
29+
```
30+
31+
Launch a new container demo using (note: this will also open your web browser to the device after it is onboarded):
32+
33+
```sh
34+
c8y tedge demo start mydemo01
35+
```
36+
37+
Like most cli commands, you can view extra options by looking at the help, using the `--help` flag on any given command.
38+
39+
```sh
40+
c8y tedge demo start --help
41+
```
42+
43+
Afterwards, you can stop the demo and delete the related devices in the cloud using:
44+
45+
```sh
46+
c8y tedge demo stop
47+
```
48+
1449
## Getting started
1550

1651
1. Download the docker compose file from the repository

0 commit comments

Comments
 (0)