# sonia-auv-cli

> SONIA AUV CLI Tools

Latest version **0.0.13** (published 2022-12-06) · GPLv3 license · 0 weekly downloads

## Install

```sh
npm install sonia-auv-cli
pnpm add sonia-auv-cli
yarn add sonia-auv-cli
bun add sonia-auv-cli
```

Provides the command `sonia`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.13 |
| Published | 2022-12-06 |
| First published | 2022-11-20 |
| Weekly downloads | 0 |
| License | GPLv3 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 16 |
| Unpacked size | 73.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | SONIA AUV Team |
| Maintainers | sonia-auv |
| Keywords | oclif |

## Links

- npm: https://www.npmjs.com/package/sonia-auv-cli
- Repository: https://github.com/sonia-auv/sonia-auv-cli
- Issues: https://github.com/sonia-auv/sonia-auv-cli/issues
- npm.io page: https://npm.io/package/sonia-auv-cli

## Dependencies (16)

- [npm](https://npm.io/package/npm.md) ^6.14.7
- [execa](https://npm.io/package/execa.md) ^4.0.2
- [listr](https://npm.io/package/listr.md) ^0.14.3
- [oclif](https://npm.io/package/oclif.md) ^1.16.1
- [tslib](https://npm.io/package/tslib.md) ^1.13.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.19
- [install](https://npm.io/package/install.md) ^0.13.0
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.14.0
- [prompts](https://npm.io/package/prompts.md) ^2.3.2
- [@types/listr](https://npm.io/package/@types/listr.md) ^0.14.2
- [@oclif/config](https://npm.io/package/@oclif/config.md) ^1.15.1
- [@oclif/command](https://npm.io/package/@oclif/command.md) ^1.6.1
- [@types/js-yaml](https://npm.io/package/@types/js-yaml.md) ^3.12.4
- [@types/prompts](https://npm.io/package/@types/prompts.md) ^2.0.8
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^3.1.0
- [@oclif/plugin-autocomplete](https://npm.io/package/@oclif/plugin-autocomplete.md) ^0.2.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.13 (latest) — 2022-12-06
- 0.0.12 — 2022-11-20

## README

sonia-cli
=========

SONIA AUV CLI Tools

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/sonia-cli.svg)](https://npmjs.org/package/sonia-cli)
[![Downloads/week](https://img.shields.io/npm/dw/sonia-cli.svg)](https://npmjs.org/package/sonia-cli)
[![License](https://img.shields.io/npm/l/sonia-cli.svg)](https://github.com/sonia-auv/sonia-cli/blob/master/package.json)

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g sonia-auv-cli
$ sonia COMMAND
running command...
$ sonia (-v|--version|version)
sonia-auv-cli/0.0.13 linux-x64 node-v12.22.12
$ sonia --help [COMMAND]
USAGE
  $ sonia COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`sonia authenticate`](#sonia-authenticate)
* [`sonia autocomplete [SHELL]`](#sonia-autocomplete-shell)
* [`sonia clone REPOSITORY`](#sonia-clone-repository)
* [`sonia diagnose [PLATFORM] [DEVICE]`](#sonia-diagnose-platform-device)
* [`sonia execute PLATFORM DEVICE CMD`](#sonia-execute-platform-device-cmd)
* [`sonia hello-world`](#sonia-hello-world)
* [`sonia help [COMMAND]`](#sonia-help-command)

## `sonia authenticate`

Add authentication credentials to access GitHub and GitHub Packages

```
USAGE
  $ sonia authenticate

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ sonia authenticate
```

_See code: [src/commands/authenticate.ts](https://github.com/sonia-auv/sonia-auv-cli/blob/v0.0.13/src/commands/authenticate.ts)_

## `sonia autocomplete [SHELL]`

display autocomplete installation instructions

```
USAGE
  $ sonia autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ sonia autocomplete
  $ sonia autocomplete bash
  $ sonia autocomplete zsh
  $ sonia autocomplete --refresh-cache
```

_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v0.2.0/src/commands/autocomplete/index.ts)_

## `sonia clone REPOSITORY`

Use this command to clone a SONIA git repository. Just put the name of the repository after this command. The exact command executed is: git clone git@github.com:sonia-auv/NAME.gitYou must have the access rights.

```
USAGE
  $ sonia clone REPOSITORY

ARGUMENTS
  REPOSITORY  Name of the git repository to clone

EXAMPLES
  $ sonia clone sonia-auv-cli
  $ sonia clone sonia-deploy
```

_See code: [src/commands/clone.ts](https://github.com/sonia-auv/sonia-auv-cli/blob/v0.0.13/src/commands/clone.ts)_

## `sonia diagnose [PLATFORM] [DEVICE]`

Diagnose the system, specific platform and/or device(s)

```
USAGE
  $ sonia diagnose [PLATFORM] [DEVICE]

ARGUMENTS
  PLATFORM  (dockbox|auv7|auv8) Platform to target. None = all
  DEVICE    (router|switch|computer|dvl|sonar) Device to target (must be contain in specified platform). None = all

OPTIONS
  -h, --help  show CLI help

EXAMPLES
  $ sonia diagnose
  $ sonia diagnose dockbox
  $ sonia diagnose auv7
  $ sonia diagnose auv7 dvl
  $ sonia diagnose auv8 computer
```

_See code: [src/commands/diagnose.ts](https://github.com/sonia-auv/sonia-auv-cli/blob/v0.0.13/src/commands/diagnose.ts)_

## `sonia execute PLATFORM DEVICE CMD`

Execute a command to a remote device

```
USAGE
  $ sonia execute PLATFORM DEVICE CMD

ARGUMENTS
  PLATFORM  (auv7|auv8) Platform to target
  DEVICE    (computer) Device to target
  CMD       (ssh|shutdown|reboot) Command to execute (must be contain in specified platform-device)

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ sonia exec

EXAMPLES
  $ sonia execute auv7 computer ssh
  $ sonia execute auv7 computer shutdown
  $ sonia execute auv8 computer reboot
```

_See code: [src/commands/execute.ts](https://github.com/sonia-auv/sonia-auv-cli/blob/v0.0.13/src/commands/execute.ts)_

## `sonia hello-world`

Just hello world

```
USAGE
  $ sonia hello-world
```

_See code: [src/commands/hello-world.ts](https://github.com/sonia-auv/sonia-auv-cli/blob/v0.0.13/src/commands/hello-world.ts)_

## `sonia help [COMMAND]`

display help for sonia

```
USAGE
  $ sonia help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.1.0/src/commands/help.ts)_
<!-- commandsstop -->

---
_Source: https://npm.io/package/sonia-auv-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
