Skip to content
This repository was archived by the owner on Dec 15, 2025. It is now read-only.

Commit 0527c73

Browse files
committed
update docs
1 parent d6be086 commit 0527c73

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/readme.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,18 @@ SUBCOMMANDS:
117117
118118
```
119119

120+
## Notes on the usage of zinit
121+
122+
zinit when it starts, it automatically `monitor` all services that are configured under it's configuration directory. This only happen on starting the `zinit init`. Adding new configuration files in the config dir **does not** make it auto started.
123+
124+
New services must be `monitored` explicitly by calling the `zinit monitor <service-name>` command. Zinit will then try to load `<service-name>.yaml`. Monitor will then auto start the service.
125+
126+
Once a service is started, you can then control it with `stop`, `kill`, `restart`, or check it's status with `status` just using the service name. Changes to the config file of that service does not affect the service. Since the config file is only loaded during a monitor.
127+
128+
If you fully require to reload a config file, then the service must be `forgotten` first. This can be done by calling `zinit forget <service-name>` which is basically the opposite of monitor. Unlike monitor, forget require that the service has already been stopped by the `stop` call.
129+
130+
## Control commands
131+
120132
As already described above, once zinit starts in init mode, it auto monitor all services configured under the provided configuration directory. Once a service is 'monitored' you can control it with one of the following commands.
121133

122134
- `kill`: Similar to the unix `kill` command, it sends a signal to a named service (default to `sigterm`). If the signal terminates the service, `zinit` will auto start it since the service target state is still `up`

0 commit comments

Comments
 (0)