Skip to content

Commit

Permalink
heredoc.Doc
Browse files Browse the repository at this point in the history
  • Loading branch information
gcurtis committed May 31, 2024
1 parent 9cb8f9c commit bad5e70
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions internal/boxcli/cache.go
Original file line number Diff line number Diff line change
Expand Up @@ -82,19 +82,21 @@ func cacheConfigureCmd() *cobra.Command {
cmd := &cobra.Command{
Use: "configure",
Short: "Configure Nix to use the Devbox cache as a substituter",
Long: "Configure Nix to use the Devbox cache as a substituter.\n" +
"\n" +
"If the current Nix installation is multi-user, this command grants the Nix\n" +
"daemon access to Devbox caches by making the following changes:\n" +
"\n" +
"- Adds the current user to Nix's list of trusted users in the system nix.conf.\n" +
"- Adds the cache credentials to ~root/.aws/config.\n" +
"\n" +
"Configuration requires sudo, but only needs to happen once. The changes persist\n" +
"across Devbox accounts and organizations.\n" +
"\n" +
"This command is a no-op for single-user Nix installs that aren't running the\n" +
"Nix daemon.",
Long: heredoc.Doc(`
Configure Nix to use the Devbox cache as a substituter.
If the current Nix installation is multi-user, this command grants the Nix
daemon access to Devbox caches by making the following changes:
- Adds the current user to Nix's list of trusted users in the system nix.conf.
- Adds the cache credentials to ~root/.aws/config.
Configuration requires sudo, but only needs to happen once. The changes persist
across Devbox accounts and organizations.
This command is a no-op for single-user Nix installs that aren't running the
Nix daemon.
`),
Hidden: true,
Args: cobra.MaximumNArgs(0),
RunE: func(cmd *cobra.Command, args []string) error {
Expand Down

0 comments on commit bad5e70

Please sign in to comment.