Skip to content
Spinbox is experimental: APIs change and data may be lost. Status lists what is built and what proves it.

spin settings

View Markdown
Manage user settings for workspaces.
Every workspace you own starts with these settings, and its own .spin.yaml over them.
Use 'spin settings get' to see them.
Usage:
spin settings [flags]
spin settings [command]
Available Commands:
dotfiles Configure dotfiles repository
get View your current settings
set Update a setting
taskfile Configure startup Taskfile
Flags:
-h, --help[=true|false] help for settings
Global Flags:
--config string config file (default is $HOME/.spin/config.yaml)
-o, --output string text for a person, or json: one document of what the API answered, and no prose (default "text")
--profile string named profile to use; SPIN_PROFILE names it when this flag does not (default "default")
--traceparent string the W3C traceparent of the span this command is part of; its own span is sent to the installation unless the profile says telemetry: false
Use "spin settings [command] --help" for more information about a command.
Configure a dotfiles repository that will be cloned into new workspaces.
Examples:
spin settings dotfiles --repo https://github.com/user/dotfiles
spin settings dotfiles --repo https://github.com/user/dotfiles --branch main --install ./install.sh
spin settings dotfiles --clear
Usage:
spin settings dotfiles [flags]
Flags:
--branch string Branch to clone (default "main")
--clear[=true|false] Clear dotfiles configuration
-h, --help[=true|false] help for dotfiles
--install string Install command (default "./install.sh")
--repo string Git repository URL
Global Flags:
--config string config file (default is $HOME/.spin/config.yaml)
-o, --output string text for a person, or json: one document of what the API answered, and no prose (default "text")
--profile string named profile to use; SPIN_PROFILE names it when this flag does not (default "default")
--traceparent string the W3C traceparent of the span this command is part of; its own span is sent to the installation unless the profile says telemetry: false
View your current settings
Usage:
spin settings get [flags]
Flags:
-h, --help[=true|false] help for get
Global Flags:
--config string config file (default is $HOME/.spin/config.yaml)
-o, --output string text for a person, or json: one document of what the API answered, and no prose (default "text")
--profile string named profile to use; SPIN_PROFILE names it when this flag does not (default "default")
--traceparent string the W3C traceparent of the span this command is part of; its own span is sent to the installation unless the profile says telemetry: false
Update a user setting.
Available settings:
shell - Default shell (e.g., /bin/bash, /bin/zsh)
editor - Default editor (e.g., vim, nano)
env.KEY - Set environment variable KEY
Examples:
spin settings set shell /bin/zsh
spin settings set env.EDITOR vim
spin settings set env.GOPROXY direct
Usage:
spin settings set <key> <value> [flags]
Flags:
-h, --help[=true|false] help for set
Global Flags:
--config string config file (default is $HOME/.spin/config.yaml)
-o, --output string text for a person, or json: one document of what the API answered, and no prose (default "text")
--profile string named profile to use; SPIN_PROFILE names it when this flag does not (default "default")
--traceparent string the W3C traceparent of the span this command is part of; its own span is sent to the installation unless the profile says telemetry: false
Configure a startup Taskfile that runs when workspaces start.
Examples:
spin settings taskfile --file ./my-taskfile.yml
spin settings taskfile --validate ./my-taskfile.yml
spin settings taskfile --clear
Usage:
spin settings taskfile [flags]
Flags:
--clear[=true|false] Clear Taskfile configuration
--file string Taskfile to upload
-h, --help[=true|false] help for taskfile
--validate string Validate a Taskfile without saving
Global Flags:
--config string config file (default is $HOME/.spin/config.yaml)
-o, --output string text for a person, or json: one document of what the API answered, and no prose (default "text")
--profile string named profile to use; SPIN_PROFILE names it when this flag does not (default "default")
--traceparent string the W3C traceparent of the span this command is part of; its own span is sent to the installation unless the profile says telemetry: false

Generated by task reference from spin/cmd/cli at 51f7e0dea.

Installations run Spinbox v20261027.01; the reference is generated from spin v20261114.01 (51f7e0dea). This page as Markdown, for a model or a terminal.