The information below is to introduce you to the features and commands that myceleum provides. For more details take a look at the myceleum Documentation.
myceleum uses Docker to run and configure workspaces. If you don’t already have Docker installed, please download it here.
Docker runs as a Daemon process, so if you see a myceleum Notification saying “Make sure Docker is running“, please check that the daemon is running.
Spores are pre-configured environments that are used as the building blocks for workspaces. They are the starting point of all myceleum workspaces. Simply select the environment you would like to test or work on.
Once a spore has been selected, you will be brought to the setup wizard where you will be able to (re)name the workspace and select the spore version. It is preferable to select the latest version for a new project, as these will include the latest versions of packages and security updates. However, you might select a different version if you need a specific configuration for a project.
The final step is to configure your workspace. There are a number of settings (listed below) that you can customize
- Local Settings
These settings are computer-specific and as such will not be synced to our servers.
- Project Path: You must select the folder where your code lives. This folder will be mounted in the container when you run the workspace, so any changes in this folder will be reflected both inside of the container and on the host machine.
- IDE: Select the IDE you would like to use. If an IDE has been selected, we will open it when the workspace is launched from the desktop application.
- Terminal: You can toggle the switch on and off to decide if you want a terminal window to be opened and attached to the workspace when the workspace is ran.
Use this section to select your preferred shell for your workspace. This is the shell that will be used inside the workspace when you attach. At the moment the options are bash (default), zsh, and fish. For now, these are loading with preconfigured setups, but we hope to allow for custom configs to be added soon.
- Environment Variables
Use this section to add environment variables to the container. This is a good place to add environment configuration options likes api keys, service urls, etc.
Use this section to add port mappings to the environment. Mappings work by exposing the container ports on the host machine, for example the following mapping
[HOST: 3000 | CONTAINER: 2000] would expose the internal port 2000 on the host machine at 3000 and can now be accessed on http://localhost:3000.
Use this section to define commands that can be run from the host machine on the container (look at the CLI documentation for
mcl daemon run for more details). The following commands “start” and “stop” are special since they are accessible in the floating control window that appears when the workspace is ran from the desktop.
Use this section to add Ubuntu apt packages to the workspace. If you are already attached to a workspace (eg: using
mcl attach), you can also use
mcl add <package>.
If you encounter any issues with the spores or have any questions you can contact us at email@example.com