Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/codingtools/cdt

Awesome cli for Devs 🚀
https://github.com/codingtools/cdt

avro cdt codingtools command-line-tool crypto hacktoberfest hash minify oclif

Last synced: 3 months ago
JSON representation

Awesome cli for Devs 🚀

Awesome Lists containing this project

README

        

Welcome to @codingtools/cdt
===
CLI for Developers :sunglasses:

[![GithubCI](https://github.com/codingtools/cdt/workflows/GithubCI/badge.svg)](https://github.com/codingtools/cdt/actions?query=workflow%3AGithubCI)
[![GithubPublish](https://github.com/codingtools/cdt/actions/workflows/npmpublish.yml/badge.svg)](https://github.com/codingtools/cdt/actions/workflows/npmpublish.yml)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/82d29e2a902a4c338228d636f290d9cd)](https://app.codacy.com/gh/codingtools/cdt?utm_source=github.com&utm_medium=referral&utm_content=codingtools/cdt&utm_campaign=Badge_Grade_Dashboard)
[![codecov](https://codecov.io/gh/codingtools/cdt/branch/release%2Frelease-v0.1/graph/badge.svg)](https://codecov.io/gh/codingtools/cdt)
[![Version](https://img.shields.io/npm/v/@codingtools/cdt)](https://npmjs.org/package/@codingtools/cdt)
![npm](https://img.shields.io/npm/dt/@codingtools/cdt)
![node (scoped)](https://img.shields.io/node/v/@codingtools/cdt)[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/codingtools/cdt)](https://github.com/codingtools/cdt/graphs/commit-activity)
[![GitHub contributors](https://img.shields.io/github/contributors/codingtools/cdt)](https://github.com/codingtools/cdt/graphs/contributors)
[![License](https://img.shields.io/npm/l/@codingtools/cdt)](https://github.com/codingtools/cdt/blob/master/package.json)

## 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. 🙏

vuesax-star

* [Installation](#installation)
* [Commands](#commands)

# Installation

```sh-session
$ npm install -g @codingtools/cdt
$ cdt COMMAND
running command...
$ cdt (-v|--version|version)
@codingtools/cdt/1.0.6 darwin-arm64 node-v19.5.0
$ cdt --help [COMMAND]
USAGE
$ cdt COMMAND
...
```

# Commands

* [`cdt autocomplete [SHELL]`](#cdt-autocomplete-shell)
* [`cdt avro [COMMAND]`](#cdt-avro-command)
* [`cdt bundlephobia [PACKAGE]`](#cdt-bundlephobia-package)
* [`cdt commands`](#cdt-commands)
* [`cdt cron [STRING]`](#cdt-cron-string)
* [`cdt crypto [STRING]`](#cdt-crypto-string)
* [`cdt datetime [DATE]`](#cdt-datetime-date)
* [`cdt hash [STRING]`](#cdt-hash-string)
* [`cdt help [COMMAND]`](#cdt-help-command)
* [`cdt minify [FILE]`](#cdt-minify-file)
* [`cdt run [STRING]`](#cdt-run-string)
* [`cdt view [FILE]`](#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](https://github.com/oclif/plugin-autocomplete/blob/v0.3.0/src/commands/autocomplete/index.ts)_

## `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](https://github.com/codingtools/cdt/blob/v1.0.6/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](https://github.com/codingtools/cdt/blob/v1.0.6/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](https://github.com/oclif/plugin-commands/blob/v1.3.0/src/commands/commands.ts)_

## `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](https://github.com/codingtools/cdt/blob/v1.0.6/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](https://github.com/codingtools/cdt/blob/v1.0.6/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](https://github.com/codingtools/cdt/blob/v1.0.6/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](https://github.com/codingtools/cdt/blob/v1.0.6/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](https://github.com/oclif/plugin-help/blob/v2.2.3/src/commands/help.ts)_

## `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](https://github.com/codingtools/cdt/blob/v1.0.6/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](https://github.com/codingtools/cdt/blob/v1.0.6/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](https://github.com/codingtools/cdt/blob/v1.0.6/src/commands/view.ts)_

## Acknowledgement
* this cli uses following opensource libraries/services
* [bundlephobia](https://bundlephobia.com/)
* [avro-js](https://openbase.io/js/avro-js)
* [avsc](https://github.com/mtth/avsc)

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

## Contribution

Please Contribute to this project by forking [cdt](https://github.com/codingtools/cdt/)

Please feel free to provide any suggestion for new utility in [Issues](https://github.com/codingtools/cdt/issues)

## @codingtools/cdt

This Project is created and managed by [Ashish Patel](http://ashish.live/)

## Releasing Version
* this needs to be done from release* branch

### Increasing Version

```bash
npm version [patch|minor|major]
```
it will update readme.md and update package.json, also will create tag and commit.

### Publishing to NPM

```bash
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

```bash
oclif-dev pack
```
this will release standalone tarballs for linux, macos and windows which we can extract and uses.

### Creating Installers

```bash
oclif-dev pack:macos
oclif-dev pack:win
```
these will create installers for macos and windows

## Sponsors
> Built using Jetbrains Products
![Jetbrains](https://www.jetbrains.com/company/brand/img/jetbrains_logo.png)

## License

[MIT](https://raw.githubusercontent.com/codingtools/cdt/master/LICENSE)