Helpme CLI Tool

A CLI tool for finding and setting up development templates, running tests, and managing dependencies.

Features

• Find and generate code examples from golang built in (IN PROGRESS)
• Set up project templates (NOT STARTED)
• Generate randoom, secure and memorable passwords (DONE)
• Pull Go dependencies (DONE)
• Run tests with sample inputs and outputs (IN PROGRESS | DONE FOR CODEFORCE and it's similar)

Prerequisites

• Go 1.21 or higher

Installation

1. Clone the repository:

git clone https://github.com/vldcreation/helpme.git

2. Navigate to the project directory:

cd helpme

3. Build and install the CLI:

go install

Usage

Help Command

Display help information.

helpme help
helpme [command] help

Available Commands:
  completion        Generate the autocompletion script for the specified shell
  encode            encode file or text
  find              Find an example for a given function
  generate-password Generate a password
  help              Help about any command
  pull              Pull depdency golang
  runtest           Run Test sample with sample output
  setup             Setup project templates
  sharefile         Share workspace directory with same network
  trackclipboard    Track data from clipboard and send to your channel

Flags:
  -c, --cpuprofile   enable cpu profiling
  -h, --help         help for helpme
  -m, --memprofile   enable memory profiling
  -v, --version      version for helpme

Find Command

Search for code examples in different programming languages.

helpme find [function_name] --lang [language] [flags]

Flags:
  -l, --lang string    Language to search (go/javascript)
  -p, --pkg string     Package name (optional)
  -s, --save          Save example to a file
  -e, --exec          Run the saved example file
  -d, --dir string    Directory to save the example file (default ".")

Setup Command

Set up project templates.

helpme setup [flags]

Generate Password Command

Generate secure passwords with customizable options.

helpme generate-password [flags]

Flags:
  -h, --help       help for generate-password
  -l, --len int    Password length (words or chars)
  -q, --qty int    Quantity of passwords to generate (default 1)
  -t, --type int   Password type (0: word, 1: phrase, 2: word with special, 3: phrase with special, 4: secure)

Pull Command

Pull Go dependencies from repositories.

helpme pull [flags]

Flags:
  -H, --host string     Hostname of the repository (e.g. github.com)
  -u, --user string     Username of the repository
  -r, --repo string     Repository name
  -b, --branch string   Branch name of the repository

Run Test Command

Run tests with sample inputs and compare outputs.

helpme runtest [flags]

Flags:
  -F, --file string     Filepath of file to execute (e.g. mypackage/a.go)
  -f, --func string     Function name to invoke (e.g: MyFunc)
  -D, --debug_out      Print debug output
  -i, --input string    Input path sample (.in file)
  -o, --output string   Output path sample (.out file)

Examples

Finding a Code Example

helpme find strings.Join --lang go --save

Running a Test

helpme runtest -F mycode.go -f TestFunc -i test.in -o test.out

Pulling a Repository

helpme pull -u username -r repo-name -H github.com

Tracking Clipboard Content

helpme trackclipboard -C /path/to/track.yaml

sample config:

app:
  channel: "telegram" # local | telegram
  idle: "20s"
  debug: true
file:
  path: "~/Documents/track"
  name: "" # leave empty to use current date
telegram:
  token: "<telegram_bot_token>"
  chat_id: "<telegram_chat_id>"

Share Files Over Network

Share your workspace directory with other devices on the same network.

helpme sharefile -D /path/to/workspace -P 9000

Flags: -D, --dir string Root directory of workspace to share -P, --port string Port number for the file server (default "9000")

Once started, other devices on the same network can access the shared files through their web browser using the displayed local IP address and port number.

Development

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Create your utility function to helpme-package
4. Commit your changes (git commit -m 'Add some amazing feature')
5. Update the depdencies, you can leverage helpme to pull it's own depdencies, see make pull r=pkg for example
6. Push to the branch (git push origin feature/amazing-feature)
7. Open a Pull Request

Disclaimer

This tool is provided as-is and without any warranty. Use it at your own risk.

License

This project is licensed under the MIT License.