@codingtools/cdt

CLI for Developers 😎

Introduction

cdt is a command line utililty for developers. It is focused on facilitating the development of applications by helping devs to do required tasks through utilities provided to enhance efficienty.

Supporting the project ⭐

If you feel awesome and want to support us in a small way, please consider starring and sharing the repo! This helps us getting known and grow the community. 🙏

• Installation
• Commands

Installation

$ npm install -g @codingtools/cdt
$ cdt COMMAND
running command...
$ cdt (-v|--version|version)
@codingtools/cdt/1.0.6 linux-x64 node-v12.21.0
$ cdt --help [COMMAND]
USAGE
  $ cdt COMMAND
...

Commands

• cdt autocomplete [SHELL]
• cdt avro [COMMAND]
• cdt bundlephobia [PACKAGE]
• cdt commands
• cdt cron [STRING]
• cdt crypto [STRING]
• cdt datetime [DATE]
• cdt hash [STRING]
• cdt help [COMMAND]
• cdt minify [FILE]
• cdt run [STRING]
• cdt view [FILE]

cdt autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ cdt autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ cdt autocomplete
  $ cdt autocomplete bash
  $ cdt autocomplete zsh
  $ cdt autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

cdt avro [COMMAND]

Avro Utility command

USAGE
  $ cdt avro [COMMAND]

OPTIONS
  -c, --command=command        commands supported: get_schema,to_json,to_avro,to_csv
  -f, --file=file              input file path
  -h, --help                   show CLI help
  -o, --output=output          output file path
  -t, --schemaType=schemaType  schema type file path

See code: src/commands/avro.ts

cdt bundlephobia [PACKAGE]

Find cost of adding a npm/yarn packages or all dependencies in package.json file

USAGE
  $ cdt bundlephobia [PACKAGE]

OPTIONS
  -f, --file=file          path for package.json file
  -h, --help               show CLI help
  -p, --packages=packages  packages for which cost is required, can pass more than one separated by space

See code: src/commands/bundlephobia.ts

cdt commands

list all the commands

USAGE
  $ cdt commands

OPTIONS
  -h, --help              show CLI help
  -j, --json              display unfiltered api data in json format
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --hidden                show hidden commands
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

See code: @oclif/plugin-commands

cdt cron [STRING]

Cron Expressions helper and scheduler

USAGE
  $ cdt cron [STRING]

OPTIONS
  -d, --describe       Describe cron expressions into human readable descriptions
  -h, --help           show CLI help
  -r, --run=run        run command using cron expression
  -s, --string=string  Cron expression

See code: src/commands/cron.ts

cdt crypto [STRING]

Encryption and Decryption functionality for File/String

USAGE
  $ cdt crypto [STRING]

OPTIONS
  -d, --decryption=decryption  decryption type, Supported [AES, DES, 3DES, Rabbit, RC4, RC4Drop]
  -e, --encryption=encryption  encryption type, Supported [AES, DES, 3DES, Rabbit, RC4, RC4Drop]
  -f, --file=file              file to be encrypted/decrypted
  -h, --help                   show CLI help
  -k, --key=key                key for encryption/decryption
  -m, --mode=mode              Block Mode, Supported [CBC, CFB, CTR, OFB, ECB]
  -s, --string=string          string to be encrypted/decrypted

See code: src/commands/crypto.ts

cdt datetime [DATE]

Date and Time utility

USAGE
  $ cdt datetime [DATE]

OPTIONS
  -d, --date=date          Datetime input string, default: Current Datetime, could also be passed through argument
  -f, --format=format      Datetime format, default: Do MMMM YYYY, h:m:s A, Z UTC
  -h, --help               show CLI help
  -l, --locale=locale      Locale, default: en
  -z, --timezone=timezone  Timezone for Datetime parsing, default: Your timezone

See code: src/commands/datetime.ts

cdt hash [STRING]

Hashing functionality for a string/file

USAGE
  $ cdt hash [STRING]

OPTIONS
  -f, --file=file      file to be hashed
  -h, --help           show CLI help
  -o, --output=output  output file path
  -s, --string=string  string to be hashed
  -t, --type=type      type of hash [SHA1(default), MD5, SHA256, SHA512, RMD160 or RIPEMD160]

See code: src/commands/hash.ts

cdt help [COMMAND]

display help for cdt

USAGE
  $ cdt help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

cdt minify [FILE]

File Minifier

USAGE
  $ cdt minify [FILE]

OPTIONS
  -f, --file=file      file to be minified
  -h, --help           show CLI help
  -o, --output=output  output file path
  -t, --type=type      type of file to be minified, it will try to find type with extension supported: JS, HTML/HTM, CSS

See code: src/commands/minify.ts

cdt run [STRING]

Cron Expressions helper and scheduler

USAGE
  $ cdt run [STRING]

OPTIONS
  -h, --help           show CLI help
  -s, --string=string  command to execute, should be compatible with your shell

See code: src/commands/run.ts

cdt view [FILE]

View file content and more

USAGE
  $ cdt view [FILE]

OPTIONS
  -f, --file=file  formatted file to be shown
  -h, --help       show CLI help
  -n, --num=num    no. of rows to show, default:10

See code: src/commands/view.ts

Acknowledgement

• this cli uses following opensource libraries/services

  • bundlephobia
  • avro-js
  • avsc

  And many others, great thanks to all the people involved in developnment and support :)

Contribution

Please Contribute to this project by forking cdt

Please feel free to provide any suggestion for new utility in Issues

@codingtools/cdt

This Project is created and managed by Ashish Patel

Releasing Version

• this needs to be done from release* branch

Increasing Version

npm version [patch|minor|major] 

it will update readme.md and update package.json, also will create tag and commit.

Publishing to NPM

npm publish --access public

this will publish package to npm starting with updating README and publishing tarballs

Already a Github Action is there to publish on pushing a tag.

Creating Standalone Tarballs

oclif-dev pack

this will release standalone tarballs for linux, macos and windows which we can extract and uses.

Creating Installers

oclif-dev pack:macos 
oclif-dev pack:win 

these will create installers for macos and windows

Sponsors

Built using Jetbrains Products

License

MIT