Onboarding Guide
View Help & Flags
To see help information and a list of all flags for any command, simply use the -h flag:
Project-Specific Commands
devspace.yaml required
The project-specific commands require that your project is already initialized, i.e. there is a devspace.yaml config file.
Start Development
This command deploys the project and then starts the development mode:
To start a terminal at the end of devspace dev instead of showing the container logs, run:
This command starts the interactive mode for development:
info
Interactive mode is similar to the -t flag which shows a terminal instead of streaming the logs in the development mode but interactive mode also overrides the ENTRYPOINT of one of your containers, so you can start your application manually. This is great for debugging failing containers.
Deploy Project
This commands deploys the project to Kubernetes:
Run this command to just build, tag and push all images to a registry without deploying the project:
Open Project
This command opens the current project in the browser:
Must be deployed
This command requires that the project has already been deployed.
Commands
This command lists all available command:
Use this command to run one of the custom commands:
Profiles
This command lists all available profiles:
Use this command to switch to a different profile:
Use the -p flag to just run a single command with a different profile without switching it permanently:
Use this command to print the config after a profile has been applied:
Variables
This command lists all variables as well as their values:
Use this command to reset all variables, i.e. delete variable values from the variable cache:
Use this command to print the config after all variables have been replaced:
Dependencies
Use this command to update git-based dependencies:
This command performs a git fetch && git pull for all git-based dependencies.
Use this command to clear the dependencies cache:
General Purpose Commands
Open UI
This command opens the localhost development UI:
Development Mode
The localhost development UI starts automatically in the background when running: devspace dev
Stream Logs
This command streams logs of a container:
Terminal & Commands
This command opens an interactive terminal session for a container:
To run just a single command inside a container, use:
File Sync
This command starts an on-demand file synchronization between localhost and a container:
Development Mode
If file sync is configured in your project, it automatically starts when running: devspace dev
Use this command to view the status of the file sync during development mode:
Namespace & Contexts
This command creates a new Space:
This command switches to a different Space:
This command switches to a different kube-context:
This command sets a different namespace as default namespace for the current kube-context:
Not for Spaces
The command devspace use namespace does not work for Spaces. Use devspace use space instead.
Advanced
Clean up Images
When using Docker for image building, disk space on your local computer can get sparse after a lot of Docker builds. DevSpace provides a convenient command to clean up all images that were built with your local Docker daemon using DevSpace. This command does not remove any pushed images remotely and just clears local images and space.
In order to clean up all created images locally, simply run the following command in your project folder:
Clean up Docker
In addition, it also makes sense to prune your Docker environment to free additional space with the following command:
This command will remove:
- all stopped containers
- all networks not used by at least one container
- all dangling images
- all build cache
These commands should free up a lot of space for new image builds to come.