cmd

Documentation

Index

• Constants
• Variables
• type App
  • func NewApp(gitService git.GitService, config *config.Config) *App
  • func (a *App) CommitAction(c *cli.Context) error
  • func (a *App) ConfigAction(c *cli.Context) error
  • func (a *App) ConfigureAI(c *cli.Context) (*ai.Config, error)

Constants

const Version = "0.2.2"

Version defines the current version of the gitc tool.

Variables

var Commands = &cli.App{
	Name:    "gitc",
	Usage:   "Generate AI-powered commit messages",
	Version: Version,
	Flags: []cli.Flag{
		&cli.BoolFlag{
			Name:    "all",
			Aliases: []string{"a"},
			Usage:   "Stage all changes before generating commit message (equivalent to 'git add .')",
			EnvVars: []string{"GITC_STAGE_ALL"},
		},
		&cli.StringFlag{
			Name:  "provider",
			Value: "openai",
			Usage: "AI provider to use (openai, anthropic)",
		},
		&cli.StringFlag{
			Name:  "model",
			Value: "gpt-4o-mini",
			Usage: "Specify the OpenAI model",
		},
		&cli.StringFlag{
			Name:  "lang",
			Value: "en",
			Usage: "Set commit message language (en, fa, ru, etc.)",
		},
		&cli.IntFlag{
			Name:  "timeout",
			Value: 10,
			Usage: "Set request timeout in seconds",
		},
		&cli.IntFlag{
			Name:  "maxLength",
			Value: 200,
			Usage: "Set maximum output length of AI response",
		},
		&cli.StringFlag{
			Name:    "api-key",
			Aliases: []string{"k"},
			Usage:   "API key for the AI provider",
			EnvVars: []string{"AI_API_KEY"},
		},
		&cli.StringFlag{
			Name:    "proxy",
			Aliases: []string{"p"},
			Usage:   "Proxy URL for API requests (e.g., http://proxy.example.com:8080)",
			EnvVars: []string{"GITC_PROXY"},
		},
		&cli.StringFlag{
			Name:    "commit-type",
			Aliases: []string{"t"},
			Usage:   "Commit type for Conventional Commits (e.g., feat, fix, docs)",
			EnvVars: []string{"GITC_COMMIT_TYPE"},
		},
		&cli.StringFlag{
			Name:    "custom-convention",
			Aliases: []string{"C"},
			Usage:   "Custom commit message convention in JSON format (e.g., '{\"prefix\": \"JIRA-123\"}')",
			EnvVars: []string{"GITC_CUSTOM_CONVENTION"},
		},
		&cli.BoolFlag{
			Name:    "emoji",
			Aliases: []string{"g"},
			Usage:   "Add Gitmoji to the commit message based on commit type",
			EnvVars: []string{"GITC_GITMOJI"},
		},
		&cli.BoolFlag{
			Name:  "no-emoji",
			Usage: "Disable Gitmoji in the commit message (overrides --emoji)",
		},
		&cli.IntFlag{
			Name:    "max-redirects",
			Aliases: []string{"r"},
			Value:   5,
			Usage:   "Maximum number of HTTP redirects to follow",
			EnvVars: []string{"GITC_MAX_REDIRECTS"},
		},
		&cli.StringFlag{
			Name:    "config",
			Aliases: []string{"c"},
			Usage:   "Path to config file",
			EnvVars: []string{"GITC_CONFIG_PATH"},
		},
	},
	Before: func(c *cli.Context) error {

		if configPath := c.String("config"); configPath != "" {
			config.SetConfigPath(configPath)
		}

		cfg, err := config.Load()
		if err != nil {
			return fmt.Errorf("failed to load config: %w", err)
		}

		gitService := git.NewGitService()
		appInstance = NewApp(gitService, cfg)
		return nil
	},
	Action: func(c *cli.Context) error {
		return appInstance.CommitAction(c)
	},
	Commands: []*cli.Command{
		{
			Name:    "config",
			Aliases: []string{"cfg"},
			Usage:   "Configure AI provider settings",
			Flags: []cli.Flag{
				&cli.StringFlag{
					Name:    "provider",
					Aliases: []string{"ai"},
					Usage:   "AI provider to use (openai, anthropic)",
				},
				&cli.StringFlag{
					Name:  "model",
					Usage: "Specify the OpenAI model",
				},
				&cli.StringFlag{
					Name:  "lang",
					Usage: "Set commit message language (en, fa, ru, etc.)",
				},
				&cli.StringFlag{
					Name:    "proxy",
					Aliases: []string{"p"},
					Usage:   "Proxy URL for API requests (e.g., http://proxy.example.com:8080)",
				},
				&cli.IntFlag{
					Name:  "timeout",
					Usage: "Set request timeout in seconds",
				},
				&cli.IntFlag{
					Name:  "maxLength",
					Usage: "Set maximum output length of AI response",
				},
				&cli.IntFlag{
					Name:    "max-redirects",
					Aliases: []string{"r"},
					Usage:   "Set maximum number of HTTP redirects",
				},
				&cli.StringFlag{
					Name:    "api-key",
					Aliases: []string{"k"},
					Usage:   "API key for the AI provider",
				},
				&cli.StringFlag{
					Name:    "commit-type",
					Aliases: []string{"t"},
					Usage:   "Commit type for Conventional Commits (e.g., feat, fix, docs)",
				},
				&cli.StringFlag{
					Name:    "custom-convention",
					Aliases: []string{"C"},
					Usage:   "Custom commit message convention in JSON format (e.g., '{\"prefix\": \"JIRA-123\"}')",
				},
				&cli.BoolFlag{
					Name:    "emoji",
					Aliases: []string{"g"},
					Usage:   "Add Gitmoji to the commit message based on commit type",
				},
				&cli.BoolFlag{
					Name:  "no-emoji",
					Usage: "Disable Gitmoji in the commit message",
				},
				&cli.StringFlag{
					Name:    "config",
					Aliases: []string{"c"},
					Usage:   "Path to config file",
					EnvVars: []string{"GITC_CONFIG_PATH"},
				},
			},
			Action: func(c *cli.Context) error {

				if configPath := c.String("config"); configPath != "" {
					config.SetConfigPath(configPath)
				}

				cfg, err := config.Load()
				if err != nil {
					return fmt.Errorf("failed to load config: %w", err)
				}

				gitService := git.NewGitService()
				app := NewApp(gitService, cfg)
				return app.ConfigAction(c)
			},
		}, {
			Name:  "reset-config",
			Usage: "Reset gitc configuration to default values",
			Action: func(c *cli.Context) error {
				if err := config.Reset(); err != nil {
					return fmt.Errorf("failed to reset config: %w", err)
				}

				fmt.Println("✅ Configuration reset to defaults.")
				return nil
			},
		},
	},
}

Commands defines the CLI application configuration.

Types

type App

type App struct {
	// contains filtered or unexported fields
}

App encapsulates the application logic and dependencies

func NewApp

func NewApp(gitService git.GitService, config *config.Config) *App

NewApp creates a new App instance

func (*App) CommitAction

func (a *App) CommitAction(c *cli.Context) error

CommitAction handles the generation of commit messages

func (*App) ConfigAction

func (a *App) ConfigAction(c *cli.Context) error

ConfigAction handles configuration updates

func (*App) ConfigureAI

func (a *App) ConfigureAI(c *cli.Context) (*ai.Config, error)

ConfigureAI constructs the AI configuration with proper validation