Skip to content
This repository has been archived by the owner on May 26, 2023. It is now read-only.

docs(snap): Move usage instructions to docs #440

Merged
merged 1 commit into from
May 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ See the [CLI Getting started documentation](https://docs.edgexfoundry.org/2.2/ge

## Installing EdgeX CLI

The client can be installed using a [snap](https://github.com/edgexfoundry/edgex-cli/tree/main/snap):

```
The client can be installed using a Snap:
```bash
sudo snap install edgex-cli
```
Please refer to the [snap directory](./snap) for details.

To build, install and run `edgex-cli` natively, do the following:
```
```bash
git clone http://github.com/edgexfoundry/edgex-cli.git
cd edgex-cli
make tidy
Expand All @@ -26,7 +26,7 @@ make build
```

## Limitations
- The client requires all services to run on the local host. It does not support a distributed configuration or using the API gateway ([#427](https://github.com/edgexfoundry/edgex-cli/issues/427))
- The client requires all services to run on the localhost. It does not support a distributed configuration or using the API gateway ([#427](https://github.com/edgexfoundry/edgex-cli/issues/427))
- The `db` command from the v1 client is not supported ([#383](https://github.com/edgexfoundry/edgex-cli/issues/383))
- See this list of [all current enhancement issues](https://github.com/edgexfoundry/edgex-cli/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)

Expand Down
47 changes: 12 additions & 35 deletions snap/README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,24 @@
# EdgeX CLI Snap
[![snap store badge](https://raw.githubusercontent.com/snapcore/snap-store-badges/master/EN/%5BEN%5D-snap-store-black-uneditable.png)](https://snapcraft.io/edgex-cli)
[![edgex-cli](https://snapcraft.io/edgex-cli/badge.svg)][edgex-cli]

This folder contains snap packaging for the EdgeX-CLI Snap
This directory contains the snap packaging of the EdgeX CLI.

The snap currently supports both `amd64` and `arm64` platforms.
The snap is built automatically and published on the Snap Store as [edgex-cli].

## Installation
For usage instructions, please refer to EdgeX CLI section in [Getting Started using Snaps][docs].

### Installing snapd
The snap can be installed on any system that supports snaps. You can see how to install
snaps on your system [here](https://snapcraft.io/docs/installing-snapd/6735).

However for full security confinement, the snap should be installed on an
Ubuntu 18.04 LTS or later (Desktop or Server), or a system running Ubuntu Core 18 or later.

### Installing EdgeX CLI as a snap
The snap is published in the snap store at https://snapcraft.io/edgex-cli.
You can see the current revisions available for your machine's architecture by running the command:

```bash
$ snap info edgex-cli
```

The latest stable version of the snap can be installed using:

```bash
$ sudo snap install edgex-cli
## Build from source
Execute the following command from the top-level directory of this repo:
```

The latest development version of the snap can be installed using:

```bash
$ sudo snap install edgex-cli --edge
snapcraft
```

A specific version of the snap can be installed by setting the channel, for instance for 2.1 (Jakarta):

This will create a snap package file with `.snap` extension. It can be installed locally by setting the `--dangerous` flag:
```bash
$ sudo snap install edgex-cli --channel=2.1
sudo snap install --dangerous <snap-file>
```

For the older CLI version compatible with 1.x of EdgeX, use `--channel=1.0`


The [snapcraft overview](https://snapcraft.io/docs/snapcraft-overview) provides additional details.

**Note** - the snap has only been tested on Ubuntu Core, Desktop, and Server.
[edgex-cli]: https://snapcraft.io/edgex-cli
[docs]: https://docs.edgexfoundry.org/2.2/getting-started/Ch-GettingStartedSnapUsers/#edgex-cli