Xitmer Documentation

Note: This documentation is of the latest version of the Xitmer client software. If you find any information in this documentation to be not working, then please ensure you have the latest version of the software (v0.5.2) installed on your system.

Shell

Sometimes you may need to run some commands in the development container or in some other environments of your service. For such situations the shell commands of Xitmer can be used.

To open the shell of the development environment simply issue the following command:

xit shell service_name

You can also open the shell prompt of different environments defined in the service definition file by using the following command:

xit shell service_name env_name

The above commands will open the shell prompt in the same terminal/shell where you issued the command. If you however wish to open of the shell window in a separate external window you can issue the -e flag at the end of the command to do so. For example, following command will open the shell prompt of the specified environment in an external window:

xit shell service_name env_name -e

Note: Please note that, the shell functionality provided is only for convinience purpose of easy and quick shell access to various service environments. It may not provide functionalities like autocompletion through the tab key. You may want to open the codebase through VS Code and use the shell provided by it for additional requirements.