osexec

Simple utilities to use Golang's os/exec package.

CHINESE README

中文说明

Features

• Custom Execution Configurations: Execute commands with customizable environment variables, working paths, and shell options.

Installation

go get github.com/yyle88/osexec  

CommandConfig Structure and Methods

CommandConfig structure provides a flexible way to configure and execute commands. You can set custom environment variables, directories, shell types, and debug options using a chainable interface.

NewCommandConfig() *CommandConfig

Creates and returns a new CommandConfig instance.

Example:

config := osexec.NewCommandConfig()

Chainable Methods

• *WithEnvs(envs []string) CommandConfig: Sets custom environment variables.
• *WithPath(path string) CommandConfig: Sets the working path.
• *WithShellType(shellType string) CommandConfig: Sets the shell type (e.g., bash).
• *WithShellFlag(shellFlag string) CommandConfig: Sets the shell flag (e.g., -c).
• *WithShell(shellType, shellFlag string) CommandConfig: Sets shell type and flag.
• *WithBash() CommandConfig: Configures the command to use bash -c.
• *WithZsh() CommandConfig: Configures the command to use zsh -c.
• *WithSh() CommandConfig: Configures the command to use sh -c.
• *WithDebugMode(debugMode bool) CommandConfig: Enables / disables debug mode.

Example:

package main

import (
	"fmt"
	"github.com/yyle88/osexec"
)

func main() {
	// Create a new CommandConfig instance and set the working directory and debug mode
	config := osexec.NewCommandConfig().
		WithPath("/path/to/directoryName").
		WithDebugMode(true)

	output, err := config.Exec("echo", "Hello, World!")
	if err != nil {
		fmt.Println("Reason:", err)
	} else {
		fmt.Println("Output:", string(output))
	}
}

---

License

MIT License. See LICENSE.

---

Contributing

Contributions are welcome! To contribute:

1. Fork the repo on GitHub (using the webpage interface).
2. Clone the forked project (git clone https://github.com/yourname/repo-name.git).
3. Navigate to the cloned project (cd repo-name)
4. Create a feature branch (git checkout -b feature/xxx).
5. Stage changes (git add .)
6. Commit changes (git commit -m "Add feature xxx").
7. Push to the branch (git push origin feature/xxx).
8. Open a pull request on GitHub (on the GitHub webpage).

Please ensure tests pass and include relevant documentation updates.

---

Support

Welcome to contribute to this project by submitting pull requests and reporting issues.

If you find this package valuable, give me some stars on GitHub! Thank you!!!

Thank you for your support!

Happy Coding with this package! 🎉

Give me stars. Thank you!!!

---

GitHub Stars