Skip to main content

Neulabs cli

Project description


id: index title: Neucli

Neulabs CLI

The neulabs CLI is used to aggregate all those activities and commands useful to various developers, reducing development costs and creating shared standards. The goal of neucli is to facilitate the generation and use of standard components such as documentation structure, GitHub actions for releases, and more.

Neucli is based on Taskfile, a task runner that allows the creation of modular CLIs through YAML configurations. Each command has its own structure, some of them are Python modules, while others are simple Bash scripts. This approach makes it easy to add additional modules in various programming languages, and you can also create your own custom commands locally and add them to the CLI.

Installation

Requirements

  • Python >= 3.8 [install]
  • Nodjs >= 16.14 [install]
  • Homebrew (only on MacOS)

Steps

  1. Donwload taskfiles/cli/cli.yml from neulabs-cli repository
  2. Install task command
    • [ Linux ] npm install -g @go-task/cli
    • [ MacOS ] brew install go-task
  3. Install neucli:
    pip3 install neucli
    neucli --installer
    
  4. Delete cli.yml and restart terminal
  5. Run neucli help

Getting started

Help command

neucli help

Summary command

neucli summary -- command

Pass args to command

neucli command -- -opt-1 value --opt-2 -x --zyx

Own cli commands

  • In the file ~/.neulabs-cli/Taskfile.local.yml you can add your own commands as desired.
  • Then you can use your command with neucli local:command-name

Dev mode

Setup git clone https://github.com/neulabscom/neulabs-cli.git && cd neulabs-cli git submodule update --init --recursive

./bin/neucli dev:setup:installer

source .activate
neucli cli:deps:all

Test neucli commands

source .activate
neucli --debug dev:utils:lint

Test installer with debug mode

neucli --debug cli:installer

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

neucli-0.2.7.tar.gz (20.4 kB view details)

Uploaded Source

File details

Details for the file neucli-0.2.7.tar.gz.

File metadata

  • Download URL: neucli-0.2.7.tar.gz
  • Upload date:
  • Size: 20.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for neucli-0.2.7.tar.gz
Algorithm Hash digest
SHA256 ee9c545b65d02ff0c8ac473a730ab3836407edab76f54d38808a525f21d928ca
MD5 8490ac47656206851b75fd09c1038f88
BLAKE2b-256 ec5d1f3f74078e562c10e8a7625aae6aa5450fa66b4b741c0f0e7b052b5b3733

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page