You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Enapter CLI is a command-line interface tool for managing Enapter services, including sites, devices, blueprints, and the rule engine. It provides a comprehensive set of commands for interacting with the Enapter Cloud platform and Gateway devices.
9
+
10
+
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).
6
11
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
12
It helpful in the following cases:
9
13
10
14
1. Managing all your EMS setup as a code with Git and Ansible / Puppet
@@ -28,6 +32,22 @@ Version 3:
28
32
brew tap enapter/tap && brew install enapter@3
29
33
```
30
34
35
+
## How to upgrade
36
+
37
+
### macOS - recommended
38
+
39
+
Version 1:
40
+
41
+
```bash
42
+
brew upgrade enapter
43
+
```
44
+
45
+
Version 3:
46
+
47
+
```bash
48
+
brew upgrade enapter@3
49
+
```
50
+
31
51
### Get prebuilt binaries
32
52
33
53
Choose your platform and required release on the [Releases page](https://github.com/Enapter/enapter-cli/releases).
@@ -59,43 +79,87 @@ Enapter CLI requires access token for authentication. Obtaining of the token is
59
79
4. Follow the instructions on the screen
60
80
<imgsrc="./.assets/token.png">
61
81
62
-
5. Set environment variable `ENAPTER3_API_TOKEN` with new token. To make it permanent don't forget to add it to configuration files of your shell.
82
+
5. Set environment variable `ENAPTER_API_TOKEN` with new token. To make it permanent don't forget to add it to configuration files of your shell.
63
83
64
84
```bash
65
-
exportENAPTER3_API_TOKEN="your token"
85
+
exportENAPTER_API_TOKEN="your token"
66
86
```
67
87
68
88
Please note that if you don't save your token, it is not possible to reveal it anymore. You need generate new token.
69
89
70
90
## How to use Version 3:
71
91
72
-
### API token
92
+
### Authentication
73
93
74
-
Enapter CLI requires access token for authentication. Obtaining of the token is easy and can be done by following few steps.
94
+
The Enapter CLI requires an access token for authentication. You can obtain your access token from your Enapter Cloud account settings at [Enapter Cloud](https://cloud.enapter.com).
75
95
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.
96
+
### Setting Up Your First Enapter Cloud Connection
80
97
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
-
```
98
+
The recommended way to use the Enapter CLI is by setting up named connections. This approach allows you to:
--blueprint-path ./blueprint/ # or ./blueprint.enbp
150
+
```
92
151
93
152
### Autocompletion in your favourite terminal app
94
153
95
154
> [!NOTE]
96
155
> Available for Version 1 now.
156
+
>
157
+
> For Version 3. Please follow enapble `Dev mode` and use [https://github.com/nkrasko/autocomplete](https://github.com/nkrasko/autocomplete) repository until merge request is accepted.
97
158
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.
159
+
In order to make life easier with command line interface, you may use [Kiro CLI](https://kiro.dev/cli/). This autocompletion tool has native support for the Enapter CLI for Mac OS X and Linux.
0 commit comments