# xmesh

> xmesh command line to create, develop and publish algorithms to asteria

Latest version **0.2.5** (published 2020-06-08) · ISC license · 0 weekly downloads

## Install

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

Provides the commands `xm`, `xmesh`, `xm-init`, `xm-login`, `xm-create`, `xm-delete`, `xm-export`, `xm-import`, `xm-update`, `xm-upload`, `xm-publish`, `xmesh-init`, `xm-download`, `xmesh-login`, `xmesh-create`, `xmesh-delete`, `xmesh-export`, `xmesh-import`, `xmesh-update`, `xmesh-upload`, `xmesh-publish`, `xmesh-download`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.5 |
| Published | 2020-06-08 |
| First published | 2019-11-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 13 |
| Unpacked size | 133.5 KB |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| Author | taozhi8833998 |
| Maintainers | taozhi8833998 |
| Keywords | xmesh, asteria, command-line |

## Links

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

## Dependencies (13)

- [ora](https://npm.io/package/ora.md) ^4.0.3
- [axios](https://npm.io/package/axios.md) ^0.19.0
- [chalk](https://npm.io/package/chalk.md) ^3.0.0
- [clear](https://npm.io/package/clear.md) ^0.1.0
- [debug](https://npm.io/package/debug.md) ^4.1.1
- [dotenv](https://npm.io/package/dotenv.md) ^8.2.0
- [figlet](https://npm.io/package/figlet.md) ^1.2.4
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.3
- [inquirer](https://npm.io/package/inquirer.md) ^7.0.0
- [minimist](https://npm.io/package/minimist.md) ^1.2.0
- [commander](https://npm.io/package/commander.md) ^4.0.1
- [form-data](https://npm.io/package/form-data.md) ^3.0.0
- [cli-progress](https://npm.io/package/cli-progress.md) ^3.4.0

## Recent versions

- 0.2.5 (latest) — 2020-06-08
- 0.2.4 — 2020-03-13
- 0.2.3 — 2019-12-13
- 0.2.2 — 2019-12-13
- 0.2.1 — 2019-12-13
- 0.2.0 — 2019-12-13
- 0.1.1 — 2019-12-11
- 0.1.0 — 2019-12-11
- 0.0.10 — 2019-11-29
- 0.0.9 — 2019-11-28
- 0.0.8 — 2019-11-28
- 0.0.7 — 2019-11-28
- 0.0.6 — 2019-11-27
- 0.0.5 — 2019-11-27
- 0.0.4 — 2019-11-27
- … 3 more at https://npm.io/package/xmesh/versions

## README

# Xmesh Cli

## :star: Description

Xmesh command line tool for create, develop and publish algorithms, it could help algorithm programmer develop more faster, more concentrated and more simple.

## :tada: Install

```bash
npm install xmesh -g

or

yarn global add xmesh
```

## :rocket: Usage

After install, run `xmesh` or `xm` in terminal

```bash
> xmesh
```

## :zap: DEBUG MODE

```bash
> DEBUG=* xmesh
```

### Common

- run `xm --version` to get the cli version

- run `xm help <commander>` to get the commander help


### Update xm command line tool version

- run `xm update` to install the latest xmesh cli version

### Login

Xmesh-Cli is a common command line tool, you can connect to any `Asteria` platform you want by configuration

- create env file named `xmesh.env`

- env file contents

	```properties
	HOST={asteria-host}
	ACCESS_TOKEN={asteria-token}
  USER={asteria-user}
  PASSWORD={asteria-user-password}
	```

- run `xm login --env xmesh.env` to init the config


### Init Project

- run `xm init`
- init sucessfully

### Create Algorithm

- run `xm create -n {algorithm name}` to create `algorithm-name` algorithm, it will download `algorithm-name`.zip package to your pc.

### Read My Algorithms

- run `xm read -t algorithm` // get my all algorithms

- run `xm read -t algorithm -n abc` // get algorithm named as `abc`

- read more useage by `xm help read`

### Upload Algorithm

- go to the root folder of your algorithm

- run `xm upload -v {algorithm version} -n {algorithm name}` to upload current algorithm codes to asteria

### Download Algorithm

- run `xm download -v {algorithm version} -n {algorithm name}` to download current algorithm codes from asteria

### Export Algorithm

- run `xm export -v {algorithm version} -n {algorithm name}` to export current algorithm with its dependencies from asteria

### Import Algorithm

- go to the root folder of your algorithm

- run `xm import -v {algorithm version} -n {algorithm name}` to import current algorithm with its dependencies to asteria

### Publish Algorithm

- go to the root folder of your algorithm

- run `xm publish -v {algorithm version} -n {algorithm name}` to publish current algorithm to asteria


### Delete Algorithm

- run `xm delete -n abc` // delete algorithm named by abc

### Offline Algorithm

- run `xm offline -n abc` // offline algorithm named by abc

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