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.

xit init

to initialize a service from the current directory. a host service with the current directory name will be created.
host service means the code of the service is present in the host machine (not in container volume) and the service will be run from the host machine. so all required runtimes and libraries should be there in the host machine.
example: D:\Dev\my_app> xit init
- this will create a service named my_app with the service dir value set to D:\Dev\my_app

xit start

with this command you can start the followings:
- xit server - the xit proxy container required for all services
  - command: xit start server
- any one service
  - command: xit start service service_name
- multiple services
  - command: xit start services service_one,service_two,service_three
  - note: there should not be space after the comma when giving service names

xit stop

to stop any locally running service on your system
- command: xit stop service_name
to stop any remotely running service at xitmer
- command: xit stop service_name remote
to stop the xit proxy container
- command: xit stop server
to stop all locally running services
- command: xit stop services
to stop all locally running services of a particular group
- command: xit stop services group_name

xit view

to view service information
example: xit view svc|sifo|service service_name

xit up

to start all services locally
- Note: if you have many services defined it will start all service containers, so may not be ideal to do so as system resources may get all used up causing problems.
command: xit up

xit down

stops all services including the xit proxy. removes logged in sessions and keys
- command: xit down

xit list

to list all services
- command: xit list services

xit push

to push service info to xitmer.com to keep your services data in a central location from where you can pull it in different systems when required.
you can push service info of the default group or provide the desired service_group_name.
- command: xit pull service-info|sifo default|service_group_name

xit pull

to pull service info from xitmer.com. you can pull service info from the default group or provide the desired service_group_name.
- command: xit pull service-info|sifo default|service_group_name

xit create

to create a new containerized service.
- command: xit create service service_name

xit signup

to create an account at xitmer.com
- command: xit signup

xit login

to login to xitmer.com in the cli so that you can carry remote actions like xit push, pull, etc.
- command: xit login

xit logout

to logout from the current session. this will delete session and keys
command: xit logout

xit change_password

to change your xitmer.com password from the xit cli
- command: xit change_passowrd

xit forgot_password

to reset your forgotten xitmer.com password from the xit cli
- command: xit forgot_password

xit cast

to cast any locally running services on your system to the internet so that other people can access and view it without you having to host or deploy your service on a server
- command: xit cast service_name
Note: this feature may not be always available and working

xit code

this opens a visual studio code instance for a service to work on development or coding
to open a local service:
- command: xit code service_name
to open a remote service running at xitmer.com (depends on feature availability)
- command: xit code service_name remote
to open any particular environment like prod, stage, etc. defined in the service info
- command: xit code service_name prod|stage|etc

xit version

to view the xitmer client version and check for updates
- command: xit version

xit deploy

to deploy the service from your local system to any environment defined in the service info
- command: xit deploy service_name environment

xit ks

for manging secrets like passwords, certificates, etc. in the keystore. you can put, get and delete secretes from any file or inline arguments.
refer the keystore section in the documentation for details of the available commands.

xit shell

to open the terminal of the development environment of a service (container the service is running on)
- command: xit shell service_name
to open the terminal of any other environment defined in the service info
- command: xit shell service_name environment

last updated: 8th Sep, 2024