Skip to content

Latest commit

 

History

History
64 lines (41 loc) · 2.83 KB

README.md

File metadata and controls

64 lines (41 loc) · 2.83 KB
Raw

Candy

Candy CLI logo

Releases Go Reference

Candy is a CLI tool that provides a basic set of commands to perform tedious tasks such as converting YAML to JSON or JSON to YAML directly from your terminal. It's built with Go, Cobra, Viper, etc.

To install the Candy CLI, use the command go install github.com/Pradumnasaraf/candy@latest. Go will automatically install it in your $GOPATH/bin directory, which should be in your $PATH.

Once installed, you can use the candy CLI command. To confirm installation, type candy at the command line.

Note If you are getting an error like command not found: candy, then you need to add $GOPATH/bin to your $PATH environment variable. For that you can refer to this.

📚 Documentation

Check out detailed documentation for getting started and using Candy CLI here.

⭐️ Features

  • Convert JSON file to YAML
  • Convert YAML file to JSON
  • Convert Key-Value to JSON
  • Generate Dockerfile for different languages/framework
  • Generate Kubernetes manifests for different objects
  • Encode and Decode a string to base64
  • More coming soon...

📝 Usage

Usage:
  candy [command] [flags]
  candy [command]

Available Commands:
  JTY         Converts a JSON into YAML.
  KVTJ        Converts Key-Value (text) to JSON.
  YTJ         Converts a YAML into JSON.
  docker      Docker related commands. Like generating a Dockerfile for a language.
  encode      It encodes and decodes a string to base64 and vice versa.
  k8s         Kubernetes related commands. Like generating manifest files for kubernetes objects.

For detailed usage of each command, visit here

Eg candy JTY --file test.json with convert JSON into YAML and create a output.yaml in your current directory.

Eg candy docker dockerfile --lang go to generate a Dockerfile template for go.

eg candy k8s manifest --obj deployment to generate a deployment.yaml file with deployment template.

📜 License

This project is licensed under the Apache-2.0 license - see the LICENSE file for details.

🛡 Security

If you discover a security vulnerability within this project, please check the SECURITY for more information.