# remote-components-cli

> The **Remote Components CLI** is a command-line tool that allows you to publish remote components to a server. This tool simplifies the process of uploading JavaScript and CSS assets to a remote server for use in your frontend projects.

Latest version **1.2.0** (published 2024-03-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install remote-components-cli
pnpm add remote-components-cli
yarn add remote-components-cli
bun add remote-components-cli
```

Provides the command `remote-components-cli`.

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2024-03-05 |
| First published | 2023-08-07 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 9 |
| Unpacked size | 185.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | lopesdasilva |

## Links

- npm: https://www.npmjs.com/package/remote-components-cli
- npm.io page: https://npm.io/package/remote-components-cli

## Dependencies (9)

- [ora](https://npm.io/package/ora.md) ^7.0.1
- [chalk](https://npm.io/package/chalk.md) ^5.3.0
- [yargs](https://npm.io/package/yargs.md) ^17.7.2
- [readline](https://npm.io/package/readline.md) ^1.3.0
- [mime-types](https://npm.io/package/mime-types.md) ^2.1.35
- [node-fetch](https://npm.io/package/node-fetch.md) ^3.3.1
- [cli-spinner](https://npm.io/package/cli-spinner.md) ^0.2.10
- [log-symbols](https://npm.io/package/log-symbols.md) ^5.1.0
- [remote-components-cli](https://npm.io/package/remote-components-cli.md) ^1.0.3

## Recent versions

- 1.2.0 (latest) — 2024-03-05
- 1.1.0 — 2023-10-03
- 1.0.7 — 2023-09-22
- 1.0.6 — 2023-09-14
- 1.0.5 — 2023-08-25
- 1.0.4 — 2023-08-08
- 1.0.3 — 2023-08-08
- 1.0.2 — 2023-08-08
- 1.0.1 — 2023-08-08
- 1.0.0 — 2023-08-07

## README

# Remote Components CLI

The **Remote Components CLI** is a command-line tool that allows you to publish remote components to a server. This tool simplifies the process of uploading JavaScript and CSS assets to a remote server for use in your frontend projects.

![](./docs/cli.gif)

## Installation

You can install the Remote Components CLI globally using npm:

```bash
npm install -g remote-components-cli
```

### Configuration
The remote-components.config.json file in your project's root folder should have the following structure:
```json
{
  "url": "https://example.com",
  "authorization" : "Basic xyz"
}
```

Make sure to replace "https://example.com" with the actual URL of your remote server where you want to publish the components.
The authorization field is not mandatory

### Usage

To use the Remote Components CLI, follow these steps:

1. Create a configuration file called remote-components.config.json in the root folder of your frontend project. This configuration file should contain the necessary settings, including the server URL and any other relevant parameters.
2. Use the publish command to upload your assets to the remote server. You can run the following command:
```bash
remote-components-cli publish
```
3. Follow the prompts to confirm and customize the upload process if required.
4. Once the upload is complete, your remote components will be available on the specified server.

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