# dcl-cli

> CLI tool for parcel management.

Latest version **0.1.4** (published 2018-01-21) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install dcl-cli
pnpm add dcl-cli
yarn add dcl-cli
bun add dcl-cli
```

Provides the command `dcl`.

## Health

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

Positive: no vulnerabilities.

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

Negative: insecure dependencies; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2018-01-21 |
| First published | 2018-01-21 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 20 |
| Known vulnerabilities | 0 (+34 in 2 direct dependencies) |
| Install scripts | no |
| Author | Decentraland |
| Maintainers | eordano |
| Keywords | decentraland, cli |

## Links

- npm: https://www.npmjs.com/package/dcl-cli
- Repository: https://github.com/decentraland/cli
- Homepage: https://github.com/decentraland/cli#readme
- Issues: https://github.com/decentraland/cli/issues
- npm.io page: https://npm.io/package/dcl-cli

## Dependencies (20)

- [koa](https://npm.io/package/koa.md) ^2.4.1
- [next](https://npm.io/package/next.md) ^4.2.2
- [axios](https://npm.io/package/axios.md) ^0.17.1
- [chalk](https://npm.io/package/chalk.md) ^2.3.0
- [react](https://npm.io/package/react.md) ^16.2.0
- [vorpal](https://npm.io/package/vorpal.md) ^1.12.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^5.0.0
- [inquirer](https://npm.io/package/inquirer.md) ^5.0.0
- [ipfs-api](https://npm.io/package/ipfs-api.md) ^17.2.6
- [progress](https://npm.io/package/progress.md) ^2.0.0
- [react-dom](https://npm.io/package/react-dom.md) ^16.2.0
- [koa-router](https://npm.io/package/koa-router.md) ^7.3.0
- [koa-static](https://npm.io/package/koa-static.md) ^4.0.2
- [root-check](https://npm.io/package/root-check.md) ^1.0.0
- [live-server](https://npm.io/package/live-server.md) ^1.2.0
- [docker-names](https://npm.io/package/docker-names.md) ^1.0.3
- [babel-polyfill](https://npm.io/package/babel-polyfill.md) ^6.26.0
- [get-installed-path](https://npm.io/package/get-installed-path.md) ^4.0.8
- [decentraland-commons](https://npm.io/package/decentraland-commons.md) git+https://github.com/decentraland/commons.git#release
- [decentraland-contracts](https://npm.io/package/decentraland-contracts.md) git+https://github.com/decentraland/contracts.git#release

## 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.1.4 (latest) — 2018-01-21

## README

# Decentraland CLI

CLI tool for parcel management.

* [x] Quickly create new projects
* [x] Uploading scenes to IPFS
* [x] Hot reloading
* [x] Linking Ethereum to the scene
* [ ] Editor modifying local files and “uploading” to the directory
* [ ] Optimizing objects, textures
* [ ] Warnings and linting of scenes
* [ ] Compiling scripts
* [ ] Generating bundles of assets
* [ ] Manage IPFS uploading/differential uploads
* [ ] Test framework for scripting
* [ ] Snapshots of the scene

## Installation

```bash
$ npm install -g dcl-cli
```

## Usage

- Initialize new Decentraland project **from working directory**:

```bash
$ dcl init
```

- Start local development server and serve your a-minus scene:

```bash
$ dcl start
```

- Upload scene to IPFS:

First, you need to have IPFS installed locally. Download it [here](https://ipfs.io/docs/install/).
Note: You need to have IPFS daemon running for this to work!

```bash
$ dcl upload
```

- Link Ethereum to the current scene:

```bash
$ dcl link
```

- Upload scene to IPFS, update IPNS and link Ethereum to the current scene in one go:

```bash
$ dcl push
```

## Building

1. Clone the dcl-cli: `git clone https://github.com/decentraland/cli.git`
2. Go into the cli directory: `cd cli`
3. Run `npm install`
4. Link the cli with: `npm link`

`dcl` command should now be available.

For CLI tool development, run `npm start` in your terminal. The cli will use the mainnet address for the LANDRegistry contract by default. If you want to change it, you can add a `.env` file on the root folder, with a `LAND_REGISTRY_CONTRACT_ADDRESS` var. It'll use [dotenv](https://github.com/motdotla/dotenv#faq) to fetch the value. You can check the current contract addresses [here](https://contracts.decentraland.org/addresses.json).

You can run CLI commands in development mode like this: `npm start -- init`

You can do incremental compilations by running `npm run watch`, but you will need to run `npm run build` at least once before to build the `linker-app`, and if you make changes to the linker you will need to re-run `npm run build`.

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