startup-scriptprivate
Validated on 14 Dec 2023 • Last edited on 13 Feb 2024
Manage your startup scripts. Startup scripts allow you to configure a machine on first boot or on every boot.
Global Flags
These flags are available on all commands.
–log-level, -l (string, optional)
Enable debug logging. One of debug
, info
, warning
, error
, or critical
.
–json, -j (boolean, optional)
Output JSON
–api-key (string, optional)
A Paperspace public API Key used for authenticating requests
–help, -h (boolean, optional)
Show help for a command
pspace startup-script create
Create a startup script.
Flags
–fields, -F (string, optional)
The fields to include in the response.
–name, -n (string, required)
The name of the startup script
–script (string, required)
The script to run
–run-once (boolean, optional)
Whether to run once or on every boot
Global Flags
These flags are available on all commands.
–log-level, -l (string, optional)
Enable debug logging. One of debug
, info
, warning
, error
, or critical
.
–json, -j (boolean, optional)
Output JSON
–api-key (string, optional)
A Paperspace public API Key used for authenticating requests
–help, -h (boolean, optional)
Show help for a command
pspace startup-script get
Get a startup script from a team.
Arguments
[argument] (string, required)
The ID of the startup script to get
Flags
–fields, -F (string, optional)
The fields to include in the response.
Global Flags
These flags are available on all commands.
–log-level, -l (string, optional)
Enable debug logging. One of debug
, info
, warning
, error
, or critical
.
–json, -j (boolean, optional)
Output JSON
–api-key (string, optional)
A Paperspace public API Key used for authenticating requests
–help, -h (boolean, optional)
Show help for a command
pspace startup-script list
List startup scripts in your team.
Pick a subset of fields to display:
pspace startup-script list -F name -F dtCreated
Flags
–limit (number, optional)
The number of items to return in the next page.
–after (string, optional)
The cursor to fetch the next results from.
–orderBy (string, optional)
The field to order items by. One of dtCreated
.
–asc (boolean, optional)
Whether to order items ascending.
–desc (boolean, optional)
Whether to order items descending.
–fields, -F (string, optional)
The fields to include in the response.
–name, -n (string, optional)
Filter by name.
Global Flags
–log-level, -l (string, optional)
Enable debug logging. One of debug
, info
, warning
, error
, or critical
.
–json, -j (boolean, optional)
Output JSON
–api-key (string, optional)
A Paperspace public API Key used for authenticating requests
–help, -h (boolean, optional)
Show help for a command
pspace startup-script update
Update a startup script.
Arguments
[argument] (string, required)
The ID of the startup script to update
Flags
–fields, -F (string, optional)
The fields to include in the response.
–name, -n (string, optional)
The name of the startup script
–script (string, optional)
The script to run
–run-once (boolean, optional)
Whether to run once or on every boot
–enabled (boolean, optional)
Whether the startup script is enabled or not
Global Flags
These flags are available on all commands.
–log-level, -l (string, optional)
Enable debug logging. One of debug
, info
, warning
, error
, or critical
.
–json, -j (boolean, optional)
Output JSON
–api-key (string, optional)
A Paperspace public API Key used for authenticating requests
–help, -h (boolean, optional)
Show help for a command
pspace startup-script assign
Assign a startup script to a machine.
Arguments
[argument] (string, required)
The ID of the startup script to assign
Flags
–fields, -F (string, optional)
The fields to include in the response.
–machine-id (string, required)
The ID of the machine to assign the startup script to
Global Flags
These flags are available on all commands.
–log-level, -l (string, optional)
Enable debug logging. One of debug
, info
, warning
, error
, or critical
.
–json, -j (boolean, optional)
Output JSON
–api-key (string, optional)
A Paperspace public API Key used for authenticating requests
–help, -h (boolean, optional)
Show help for a command
pspace startup-script unassign
Unassign a startup script from a machine.
Arguments
[argument] (string, required)
The ID of the startup script to unassign
Flags
–fields, -F (string, optional)
The fields to include in the response.
–machine-id (string, required)
The ID of the machine to un-assign the startup script from
Global Flags
These flags are available on all commands.
–log-level, -l (string, optional)
Enable debug logging. One of debug
, info
, warning
, error
, or critical
.
–json, -j (boolean, optional)
Output JSON
–api-key (string, optional)
A Paperspace public API Key used for authenticating requests
–help, -h (boolean, optional)
Show help for a command
pspace startup-script delete
Delete a startup script from a team.
Arguments
[argument] (string, required)
The ID of the startup script to delete
Flags
–fields, -F (string, optional)
The fields to include in the response.
Global Flags
These flags are available on all commands.
–log-level, -l (string, optional)
Enable debug logging. One of debug
, info
, warning
, error
, or critical
.
–json, -j (boolean, optional)
Output JSON
–api-key (string, optional)
A Paperspace public API Key used for authenticating requests
–help, -h (boolean, optional)
Show help for a command