servicer is a user-friendly Command Line Interface (CLI) tool designed to simplify service management on systemd, abstracting away the complexities of the systemd ecosystem. With an easy-to-use API comparable to popular tools like pm2, servicer empowers users to create, control, and manage services effortlessly.
Intuitive CLI: servicer provides a simple and intuitive command-line interface, making it accessible to both beginners and experienced users.
Service Creation: Easily create and define new services by specifying essential details like service name, command, working directory, and environment variables.
Service Control: Start, stop, restart, enable, or disable services seamlessly with straightforward commands.
Process Monitoring: Monitor the status and health of services, ensuring reliable operation and automatic restarts in case of failures.
Service Logs: View real-time service logs directly from the terminal to facilitate troubleshooting and debugging.
Cross-platform Compatibility: servicer is designed to work on various Linux distributions with systemd support. MacOS and Windows support using launchd and scm is planned.
Use OS native primitives: Unlike pm2, servicer does not fork processes nor run a custom logger. It hooks up your app into systemd and gets out of the way. Logs are handled by journald. You need not worry about your services going down if something wrong happens to servicer.
Lightweight: Servicer is daemonless, i.e. does not run in the background consuming resources.
Language agnostic: Servicer comes as a binary executable which does not require rust to be installed. There is not bloat from language exclusive features, such as pm2 cluster mode for node.
Currently servicer supports Linux. Systemd must be installed on the system. MacOS (launchd) and Windows (SCM) support is planned.
Download the binary from the release page for run wget https://github.com/servicer-labs/servicer/releases/download/v0.1.2/servicer. Then setup as
```sh
chmod +rwx ./servicer
sudo mv ./servicer /usr/bin/ser
ser --help ```
```sh cargo install servicer
ser. We can now access servicer in sudo modesudo ln -s ~/.cargo/bin/servicer /usr/bin/ser ```
Run --help to display tooltip. Note that sudo mode is needed for most commands.
```sh
sudo ser create index.js
sudo ser create index.js --start --enable
sudo ser create awesome-binary
sudo ser create hello-typescript.ts --interpreter /home/hp/.config/nvm/versions/node/v20.1.0/bin/ts-node
sudo ser create index.js --name hello-world
-- followed by spacesudo ser create index.js -- --foo bar
sudo ser create index.js --env-vars "FOO=BAR GG=WP"
sudo ser create index.js --auto-restart ```
This creates a service file in etc/systemd/system/hello-world.ser.service. You must follow up with start and enable commands to start the service.
Servicer auto-detects the interpreter for node and python from $PATH available to the sudo user. You must manually provide the interpeter for other platforms using the interpreter flag, eg. --interpreter conda. If the interpreter is not found in sudo $PATH, run which conda and paste the absolute path.
You can write your own service files and manage them with servicer. Simply rename file to end with .ser.service instead of .service.
```sh sudo ser edit hello-world
sudo ser edit hello-world --editor vi ```
Opens a .service file in a text editor. Provides a template if the service doesn't exist.
sh
sudo ser start hello-world
sh
sudo ser stop hello-world
sh
sudo ser enable hello-world
sh
sudo ser disale hello-world
```sh sudo ser delete hello-world
sudo ser rm hello-world ```
Prints PID, name, active state, enabled state, CPU and memory utilization for every service.
sh
sudo ser status
+-------+-------------+--------+----------------+-------+--------+
| pid | name | active | enable on boot | cpu % | memory |
+-------+-------------+--------+----------------+-------+--------+
| 24294 | index.js | active | false | 0 | 9.5 KB |
+-------+-------------+--------+----------------+-------+--------+
Finds the .service and unit file path for a service.
sh
sudo ser which hello-world
sh
+--------------+--------------------------------------------------------------+
| name | path |
+--------------+--------------------------------------------------------------+
| Service file | /etc/systemd/system/hello-world.ser.service |
+--------------+--------------------------------------------------------------+
| Unit file | /org/freedesktop/systemd1/unit/hello_2dworld_2eser_2eservice |
+--------------+--------------------------------------------------------------+
```sh ser logs hello-world
ser logs hello-world --follow ```
sh
ser cat hello-world
nvm: node is unavailable in sudo mode. You must symlink node to the path available to sudo. Source- https://stackoverflow.com/a/40078875/7721443
sh
sudo ln -s "$NVM_DIR/versions/node/$(nvm version)/bin/node" "/usr/local/bin/node"
sudo ln -s "$NVM_DIR/versions/node/$(nvm version)/bin/npm" "/usr/local/bin/npm"
servicer is licensed under the MIT license.
servicer is distributed "as-is" and without any warranty, expressed or implied. The authors and contributors of servicer shall not be held liable for any damages or losses resulting from the use or inability to use the software.
Before using servicer, please review the MIT License and the lack of warranty carefully. By using the software, you are agreeing to the terms of the license and acknowledging the lack of warranty.
We acknowledge all the packages and libraries used in the development of servicer. Their contributions have been invaluable in making this project possible. Parts of the README and codebase are generated with ChatGPT.
We welcome contributions and feedback from the community. Feel free to open issues, submit pull requests, or share your thoughts on how we can improve servicer further.
Get started with servicer and simplify your service management on systemd. Happy service creation!