Method AddFlags

cli/provider/cmd.go:167–351

(cmd *cobra.Command)

}

func (c *CmdConfigurator) AddFlags(cmd *cobra.Command) error {
	//sets the displayment of flag-related errors
	cmd.SilenceErrors = true
	cmd.SetFlagErrorFunc(func(_ *cobra.Command, err error) error {
		PrintLogo(os.Stdout, true)
		color.Red(fmt.Sprintf("❌ error: %v", err))
		fmt.Println()
		return err
	})

	//add flags
	var err error
	cmd.Flags().SetNormalizeFunc(aliasNormalizeFunc)
	cmd.Flags().String("configPath", ".", "Path to the local directory where keploy configuration file is stored")

	switch cmd.Name() {
	case "generate", "download":
		cmd.Flags().StringSliceP("services", "s", c.cfg.Contract.Services, "Specify the services for which to generate/download contracts")
		cmd.Flags().StringSliceP("tests", "t", c.cfg.Contract.Tests, "Specify the tests for which to generate/download contracts")
		cmd.Flags().StringP("path", "p", ".", "Specify the path to generate/download contracts")
		if cmd.Name() == "download" { // for downloading contracts
			cmd.Flags().String("driven", c.cfg.Contract.Driven, "Specify the path to download contracts")
		}

	case "update", "export", "import":
		return nil
	case "postman":
		cmd.Flags().StringP("path", "p", "", "Specify the path to the postman collection")
		cmd.Flags().String("base-path", c.cfg.Test.BasePath, "basePath to hit the server while importing keploy tests from postman collection with no response in the collection")
	case "normalize":
		cmd.Flags().StringP("path", "p", ".", "Path to local directory where generated testcases/mocks/reports are stored")
		cmd.Flags().String("test-run", "", "Test Run to be normalized")
		cmd.Flags().String("tests", "", "Test Sets to be normalized")
		cmd.Flags().Bool("allow-high-risk", false, "Allow normalization of high-risk test failures")
	case "config":
		cmd.Flags().StringP("path", "p", ".", "Path to local directory where generated config is stored")
		cmd.Flags().Bool("generate", false, "Generate a new keploy configuration file")
	case "templatize":
		cmd.Flags().StringP("path", "p", ".", "Path to local directory where generated testcases/mocks are stored")
		cmd.Flags().StringSliceP("testsets", "t", c.cfg.Templatize.TestSets, "Testsets to run e.g. --testsets \"test-set-1, test-set-2\"")
	case "record", "test":
		if cmd.Parent() != nil && cmd.Parent().Name() == "contract" {
			cmd.Flags().StringSliceP("services", "s", c.cfg.Contract.Services, "Specify the services for which to generate contracts")
			cmd.Flags().StringP("path", "p", ".", "Specify the path to generate contracts")
			cmd.Flags().Bool("download", true, "Specify whether to download contracts or not")
			cmd.Flags().Bool("generate", true, "Specify whether to generate schemas for the current service or not")
			cmd.Flags().String("driven", c.cfg.Contract.Driven, "Specify the driven flag to validate contracts")
			return nil
		}

		cmd.Flags().Bool("sync", c.cfg.Record.Synchronous, "Synchronous recording of testcases")
		// `keploy record` needs --disable-mapping locally so the host
		// CLI has an explicit override path. The resolved host value is
		// forwarded to the spawned agent (docker / k8s sidecar / native
		// subprocess) via the --disable-mapping arg the orchestrator
		// appends. Without this flag here, the host can only inherit
		// the value from keploy.yml or fall back to the default in
		// config/default.go (mapping enabled). That's fine for fresh