Skip to content

feat: Add override file flag to init command (closes #184) #348

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Pmayors wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: Add override file flag to init command (closes #184) #348

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion cmd/init.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
"encoding/hex"
"errors"
"fmt"
"os"
"path/filepath"
"regexp"
"strconv"
Expand All @@ -41,7 +42,7 @@ var promptNames bool
var ffNameValidator = regexp.MustCompile(`^[0-9a-zA-Z]([0-9a-zA-Z._-]{0,62}[0-9a-zA-Z])?$`)

var stackNameInvalidRegex = regexp.MustCompile(`[^-_a-z0-9]`)

var overrideFile string
var initCmd = &cobra.Command{
Use: "init [stack_name] [member_count]",
Short: "Create a new FireFly local dev stack",
Expand All @@ -60,6 +61,26 @@ var initCmd = &cobra.Command{
}
return err
}
if overrideFile != "" {
// 1. Check if the file the user provided exists
if _, err := os.Stat(overrideFile); err != nil {
return fmt.Errorf("could not find custom override file: %s", err)
}

destPath := filepath.Join(stackManager.Stack.StackDir, "docker-compose.override.yml")
// 3. Copy the file
input, err := os.ReadFile(overrideFile)
if err != nil {
return fmt.Errorf("could not read override file: %s", err)
}

err = os.WriteFile(destPath, input, 0644)
if err != nil {
return fmt.Errorf("could not write override file: %s", err)
}

fmt.Printf("Copied custom override file to: %s\n", destPath)
}
fmt.Printf("Stack '%s' created!\nTo start your new stack run:\n\n%s start %s\n", initOptions.StackName, rootCmd.Use, initOptions.StackName)
fmt.Printf("\nYour docker compose file for this stack can be found at: %s\n\n", filepath.Join(stackManager.Stack.StackDir, "docker-compose.yml"))
return nil
Expand Down Expand Up @@ -317,6 +338,7 @@ func init() {
initCmd.PersistentFlags().IntVarP(&initOptions.ExternalProcesses, "external", "e", 0, "Manage a number of FireFly core processes outside of the docker-compose stack - useful for development and debugging")
initCmd.PersistentFlags().StringVarP(&initOptions.FireFlyVersion, "release", "r", "latest", fmt.Sprintf("Select the FireFly release version to use. Options are: %v", fftypes.FFEnumValues(types.ReleaseChannelSelection)))
initCmd.PersistentFlags().StringVarP(&initOptions.ManifestPath, "manifest", "m", "", "Path to a manifest.json file containing the versions of each FireFly microservice to use. Overrides the --release flag.")
initCmd.Flags().StringVarP(&overrideFile, "file", "f", "", "Custom docker-compose.override.yml file to copy")
initCmd.PersistentFlags().BoolVar(&promptNames, "prompt-names", false, "Prompt for org and node names instead of using the defaults")
Copy link
Contributor

@EnriqueL8 EnriqueL8 Nov 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm thinking we could rename this to be more specific this is a docker compose override file instead of just -f or --file . The CLI uses files for all sorts of things including overriding the manifest.json which contains the image.

maybe --override-file

initCmd.PersistentFlags().BoolVar(&initOptions.PrometheusEnabled, "prometheus-enabled", false, "Enables Prometheus metrics exposition and aggregation to a shared Prometheus server")
initCmd.PersistentFlags().BoolVar(&initOptions.SandboxEnabled, "sandbox-enabled", true, "Enables the FireFly Sandbox to be started with your FireFly stack")
Expand Down
Loading