Econverse NPM | npm.io

Econverse CLI

This is an amazing CLI to help Econverse in their project creations.

You might need to use Econverse CLI if you need to start a new project and have no patience to get all those files from an already finished project.

I'm assuming you actually work there.

Content tree

Quick Start

# Starting a new project in ./emania/
$ npx econverse new emania

# this message will appear if everything works as planned
> Your files were created successfully

This command will create a tree of already configured files for you, like this one:

Project tree image

And every file's name will have the selected path name:

Project tree image

If you create a new project with dot (.), the file's name will be the same as it's parent's folder

Change file's name

To change all the initial file's name is actually pretty simple, just initialize the project with the flag --file-name, or simply -f.

For example:

# Set file's name to be emania-general
$ npx econverse new emania --file-name emania-general

# Or, simply
$ npx econverse new emania -f emania-general

It will change every main file name to emania-general, as you can see here:

Project tree image

But the actual project's name will be, either the path you selected, or the parent folder's name, as we can see here in package.json

Getting parent folder's name image

More examples

If you want more examples of any command, just type econverse <command> -h.

For example, npx econverse new -h returns:

Help example image

Global Installation

You can install this package globally (which i highly recommend) with:

# with npm
$ npm install -g econverse

# or with yarn
$ yarn global add econverse

To see if it's actually working, type econverse -v.

Sometimes you need to restart your terminal

Commands

There is not more than this 1 command right now 😞, so you are actually welcome to help me and create more commands!

Contribution

This CLI was made with oclif, so you can go and take a look at their docs.

If you want to contribute with this project, you can go to this repository and clone it with:

$ git clone https://github.com/gasampaiosouza/econverse-cli.git

# or with hub
$ hub clone gasampaiosouza/econverse-cli

You can create new commands by creating a new .ts file inside src/commands, and pasting this template:

// src/commands/yourNewCommand.ts

import Command from '@oclif/command'

// yeah, it must be a class.. but it's also cool, don't worry!
export class MyCommand extends Command {
  static description = 'your command description...'

  // this function is the only required part
  async run() {
    console.log('running my command')
  }
}