Skip to content

Commit 65f331a

Browse files
committed
Merge master into v3 branch
Resolve merge conflicts to enable CI checks. Squashed commit of the following: commit 36d65cf Author: Nikolay V. Krasko <[email protected]> Date: Fri Sep 5 15:52:41 2025 +0400 adding notes with status commit 2277748 Author: Nikolay V. Krasko <[email protected]> Date: Fri Sep 5 15:43:37 2025 +0400 addding enapter3 cli usage description
1 parent 7ba2b35 commit 65f331a

File tree

1 file changed

+47
-5
lines changed

1 file changed

+47
-5
lines changed

README.md

Lines changed: 47 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,26 @@
44
[![Release](https://img.shields.io/github/release/enapter/enapter-cli.svg)](https://github.com/enapter/enapter-cli/releases/latest)
55

66

7-
This tool helps Enapter customers to work with devices. It useful in the following cases:
8-
1. Develop devices via blueprints.
9-
2. Update and monitor devices.
7+
This tool helps Enapter customers to work with devices it is alternative for [Enapter IDE for EMS Toolkit 3.0](https://marketplace.visualstudio.com/items?itemName=Enapter.enapter-ems-toolkit-ide).
8+
It helpful in the following cases:
9+
10+
1. Managing all your EMS setup as a code with Git and Ansible / Puppet
11+
2. Establishing CI/CD workflow
12+
3. Development and debugging of Enapter Blueprints
13+
4. Development and debugging of Enapter Gateway Rules
1014

1115
## How to install
1216

1317
###  macOS - recommended
1418

19+
Version 1:
20+
21+
```bash
22+
brew tap enapter/tap && brew install enapter
23+
```
24+
25+
Version 3:
26+
1527
```bash
1628
brew tap enapter/tap && brew install enapter@3
1729
```
@@ -32,7 +44,10 @@ Also you can pass custom output path:
3244
./build.sh /usr/local/bin/enapter
3345
```
3446

35-
## How to use
47+
## How to use Version 1:
48+
49+
> [!NOTE]
50+
> Version 1 works only with Enapter Cloud connection.
3651
3752
### API token
3853

@@ -52,8 +67,35 @@ Enapter CLI requires access token for authentication. Obtaining of the token is
5267

5368
Please note that if you don't save your token, it is not possible to reveal it anymore. You need generate new token.
5469

70+
## How to use Version 3:
71+
72+
### API token
73+
74+
Enapter CLI requires access token for authentication. Obtaining of the token is easy and can be done by following few steps.
75+
76+
1. Navigate to your Enapter Gateway 3.0 Web Interface `Settings` page by using IP address or mDNS name [http://enapter-gateway.local/settings](https://enapter-gateway.local/settings)
77+
2. Enapter your Enapter Gateway password
78+
3. Click `API Token` and copy token to clipboard
79+
4. Set environment variables `ENAPTER3_API_TOKEN`, `ENAPTER3_API_URL` and `ENAPTER3_API_ALLOW_INSECURE`. To make it permanent don't forget to add it to configuration files of your shell.
80+
81+
```bash
82+
export ENAPTER3_API_TOKEN="your token"
83+
export ENAPTER3_API_URL="http://ip_address/api"
84+
export ENAPTER3_API_ALLOW_INSECURE=true
85+
```
86+
87+
5. Check connection works by running
88+
89+
```bash
90+
enapter3 device list
91+
```
92+
5593
### Autocompletion in your favourite terminal app
5694

57-
In order to make life easier with command line interface, you may use [Fig - the next-generation command line](https://fig.io/). This autocompletion tool has native support for the Enapter CLI for Mac OS X and Linux.
95+
> [!NOTE]
96+
> Available for Version 1 now.
97+
98+
In order to make life easier with command line interface, you may use [Amazon Q](https://aws.amazon.com/q/). This autocompletion tool has native support for the Enapter CLI for Mac OS X and Linux.
5899

59100
<img src="./.assets/enapter-cli-fig-integration.gif">
101+

0 commit comments

Comments
 (0)