# r1ec

> ArvanCloud Edge Computing CLI

Latest version **0.8.0** (published 2024-11-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install r1ec
pnpm add r1ec
yarn add r1ec
bun add r1ec
```

Provides the command `r1ec`.

## Health

**Score 40/100 (D)** — status: maintenance-mode.

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

Warnings: low downloads; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.8.0 |
| Published | 2024-11-05 |
| First published | 2024-09-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=18.0.0 |
| Dependencies | 21 |
| Unpacked size | 43.4 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Author | ArvanCloud |
| Maintainers | r1-ec |
| Keywords | arvancloud, cli, worker, edge-computing |

## Links

- npm: https://www.npmjs.com/package/r1ec
- npm.io page: https://npm.io/package/r1ec

## Dependencies (21)

- [ora](https://npm.io/package/ora.md) ^8.0.1
- [open](https://npm.io/package/open.md) ^9.1.0
- [toml](https://npm.io/package/toml.md) ^3.0.0
- [axios](https://npm.io/package/axios.md) ^1.6.2
- [chalk](https://npm.io/package/chalk.md) 4.1.2
- [humps](https://npm.io/package/humps.md) ^2.0.1
- [listr](https://npm.io/package/listr.md) ^0.14.3
- [sinon](https://npm.io/package/sinon.md) ^17.0.1
- [dotenv](https://npm.io/package/dotenv.md) ^16.3.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [express](https://npm.io/package/express.md) ^4.18.2
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.5
- [fs-extra](https://npm.io/package/fs-extra.md) ^11.2.0
- [inquirer](https://npm.io/package/inquirer.md) ^9.2.12
- [@oclif/core](https://npm.io/package/@oclif/core.md) ^3.11.0
- [body-parser](https://npm.io/package/body-parser.md) ^1.20.2
- [simple-oauth2](https://npm.io/package/simple-oauth2.md) ^5.0.0
- [@types/shelljs](https://npm.io/package/@types/shelljs.md) ^0.8.15
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^6.0.7
- [@oclif/plugin-autocomplete](https://npm.io/package/@oclif/plugin-autocomplete.md) ^3.0.1
- [@oclif/plugin-warn-if-update-available](https://npm.io/package/@oclif/plugin-warn-if-update-available.md) ^3.1.11

## 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.8.0 (latest) — 2024-11-05
- 0.7.0 (beta) — 2024-10-26
- 0.6.3 — 2024-09-22

## README

# Arvan Cloud Edge Computing CLI

ArvanCloud's Edge Computing CLI is a tool designed to empower developers with the ability to seamlessly deploy and
manage applications on the edge servers. This CLI tool provides an intuitive, easy-to-use interface for leveraging the
benefits of edge computing, such as reduced latency and improved performance, by enabling applications to be closer to
end-users.

<!-- This section will be generated with oclif, DON'T FILL IT MANUALLY! -->

# Usage

<!-- usage -->

```sh-session
$ npm install -g r1ec
$ r1ec COMMAND
running command...
$ r1ec (--version)
r1ec/0.6.3 darwin-arm64 node-v18.20.2
$ r1ec --help [COMMAND]
USAGE
  $ r1ec COMMAND
...
```

<!-- usagestop -->

# Commands

<!-- commands -->

* [`r1ec autocomplete [SHELL]`](#r1ec-autocomplete-shell)
* [`r1ec delete [EDGECOMPUTE]`](#r1ec-delete-edgecompute)
* [`r1ec deploy PROJECTNAME`](#r1ec-deploy-projectname)
* [`r1ec docs`](#r1ec-docs)
* [`r1ec help [COMMANDS]`](#r1ec-help-commands)
* [`r1ec history`](#r1ec-history)
* [`r1ec init [PROJECTNAME]`](#r1ec-init-projectname)
* [`r1ec list`](#r1ec-list)
* [`r1ec log [EDGECOMPUTE]`](#r1ec-log-edgecompute)
* [`r1ec login`](#r1ec-login)
* [`r1ec logout`](#r1ec-logout)

## `r1ec autocomplete [SHELL]`

Display autocomplete installation instructions.

```
USAGE
  $ r1ec autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  (zsh|bash|powershell) Shell type

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

DESCRIPTION
  Display autocomplete installation instructions.

EXAMPLES
  $ r1ec autocomplete

  $ r1ec autocomplete bash

  $ r1ec autocomplete zsh

  $ r1ec autocomplete powershell

  $ r1ec autocomplete --refresh-cache
```

## `r1ec delete [EDGECOMPUTE]`

You can search and delete your edge-computes by selecting them in the list

```
USAGE
  $ r1ec delete [EDGECOMPUTE]

ARGUMENTS
  EDGECOMPUTE  search for edge-compute to delete

DESCRIPTION
  You can search and delete your edge-computes by selecting them in the list
```

## `r1ec deploy PROJECTNAME`

Deploy your project's files.

```
USAGE
  $ r1ec deploy PROJECTNAME -f <value> [-n <value>]

ARGUMENTS
  PROJECTNAME  set a name for project.

FLAGS
  -f, --fileName=<value>   (required) Enter your built JS/TS file path
  -n, --namespace=<value>  َUse this flag to deploy into a namespace other than the default one.

DESCRIPTION
  Deploy your project's files.
```

## `r1ec docs`

Open the documentation page for ArvanCloud's Edge Computing CLI.

```
USAGE
  $ r1ec docs -l fa|en

FLAGS
  -l, --lang=<option>  (required) [default: en] Open documentation as selected language
                       <options: fa|en>

DESCRIPTION
  Open the documentation page for ArvanCloud's Edge Computing CLI.
```

## `r1ec help [COMMANDS]`

Display help for r1ec.

```
USAGE
  $ r1ec help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for r1ec.
```

## `r1ec history`

```
USAGE
  $ r1ec history
```

## `r1ec init [PROJECTNAME]`

Initialize the Edge Compute project.

```
USAGE
  $ r1ec init [PROJECTNAME]

ARGUMENTS
  PROJECTNAME  set a name for project. default get the template name

DESCRIPTION
  Initialize the Edge Compute project.
```

## `r1ec list`

You can see the list of edge-computes or search by name

```
USAGE
  $ r1ec list [-s <value>]

FLAGS
  -s, --search=<value>  َUse this flag to search for edge-compute

DESCRIPTION
  You can see the list of edge-computes or search by name
```

## `r1ec log [EDGECOMPUTE]`

You can select edge-computes to retrieve logs by selecting them in the list

```
USAGE
  $ r1ec log [EDGECOMPUTE] [-l <value>]

ARGUMENTS
  EDGECOMPUTE  Select edge-compute for retrieving log

FLAGS
  -l, --logLevel=<value>  َUse this flag to filter logs by log level. Valid values: ERROR, WARN, INFO, DEBUG

DESCRIPTION
  You can select edge-computes to retrieve logs by selecting them in the list
```

## `r1ec login`

Log in to the ArvanCloud Edge Computing.

```
USAGE
  $ r1ec login [-m <value>]

FLAGS
  -m, --machine-user=<value>  Login via Machine Uesr

DESCRIPTION
  Log in to the ArvanCloud Edge Computing.
```

## `r1ec logout`

Log out from the logged-in account.

```
USAGE
  $ r1ec logout

DESCRIPTION
  Log out from the logged-in account.
```

<!-- commandsstop -->

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