Compare commits
4 commits
308f9e6b11
...
3aa7f9e722
| Author | SHA1 | Date | |
|---|---|---|---|
| 3aa7f9e722 | |||
| 7673787736 | |||
| 19ccb76235 | |||
| f32bf5495b |
9 changed files with 907 additions and 73 deletions
17
.forgejo/workflows/ci.yml
Normal file
17
.forgejo/workflows/ci.yml
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
name: CI
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
pull_request:
|
||||||
|
branches: [main]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
shellcheck:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- name: Install ShellCheck
|
||||||
|
run: sudo apt-get update && sudo apt-get install -y shellcheck
|
||||||
|
- name: Run ShellCheck
|
||||||
|
run: shellcheck systab
|
||||||
20
CLAUDE.md
20
CLAUDE.md
|
|
@ -18,16 +18,16 @@ No build step. The script requires `bash`, `systemctl`, and optionally `notify-s
|
||||||
|
|
||||||
The script has two modes controlled by CLI flags:
|
The script has two modes controlled by CLI flags:
|
||||||
|
|
||||||
- **Job creation** (`-t <time> [-c <cmd> | -f <script> | stdin]`): Generates a systemd `.service` + `.timer` pair with a 6-char hex short ID, reloads the daemon, and enables/starts the timer. Time specs are parsed via `parse_time` which handles natural language (`every 5 minutes`), `date -d` relative/absolute times, and raw systemd OnCalendar values. One-time jobs get `Persistent=false` and `RemainAfterElapse=no` (auto-unload after firing). All jobs log stdout/stderr to the journal via `SyslogIdentifier`. Notifications (`-i` desktop, `-m` email, `-o` include output) use `ExecStopPost` so they fire on both success and failure with status-aware icons/messages. The `-o [N]` flag fetches the last N lines of journal output (default 10) and includes them in the notification body (also configurable in edit mode as `o` or `o=N`). Notification flags are persisted in the service file as a `# SYSTAB_FLAGS=` comment.
|
- **Job creation** (`-t <time> [-n <name>] [-c <cmd> | -f <script> | stdin]`): Generates a systemd `.service` + `.timer` pair with a 6-char hex short ID, reloads the daemon, and enables/starts the timer. An optional `-n <name>` assigns a human-readable name that can be used interchangeably with hex IDs in all operations. Time specs are parsed via `parse_time` which handles natural language (`every 5 minutes`), `date -d` relative/absolute times, and raw systemd OnCalendar values. One-time jobs get `Persistent=false` and `RemainAfterElapse=no` (auto-unload after firing). All jobs log stdout/stderr to the journal via `SyslogIdentifier`. Notifications (`-i` desktop, `-m` email, `-o` include output) use `ExecStopPost` so they fire on both success and failure with status-aware icons/messages. The `-o [N]` flag fetches the last N lines of journal output (default 10) and includes them in the notification body (also configurable in edit mode as `o` or `o=N`). Notification flags are persisted in the service file as a `# SYSTAB_FLAGS=` comment.
|
||||||
|
|
||||||
- **Management** (`-D`, `-E`, `-e`, `-L`, `-S`, `-C`, `-h` — mutually exclusive):
|
- **Management** (`-D`, `-E`, `-e`, `-L`, `-S`, `-C`, `-h` — mutually exclusive):
|
||||||
- `-D <id>` / `-E <id>`: Disable (stop+disable) or enable (enable+start) a job's timer.
|
- `-D <id|name>` / `-E <id|name>`: Disable (stop+disable) or enable (enable+start) a job's timer. Accepts hex ID or name.
|
||||||
- `-e`: Opens `$EDITOR` with a pipe-separated crontab (`ID[:FLAGS] | SCHEDULE | COMMAND`). Notification flags are appended to the ID with `:` (`i` = desktop, `e=addr` = email, `o` = output 10 lines, `o=N` = output N lines, comma-separated). On save, diffs against the original to apply creates (ID=`new`), deletes (removed lines), updates (changed schedule/command/flags), and disable/enable (comment/uncomment lines).
|
- `-e`: Opens `$EDITOR` with a pipe-separated crontab (`ID[:FLAGS] | SCHEDULE | COMMAND`). Flags are appended to the ID with `:` (`i` = desktop, `e=addr` = email, `o` = output 10 lines, `o=N` = output N lines, `n=name` = job name, comma-separated). On save, diffs against the original to apply creates (ID=`new`), deletes (removed lines), updates (changed schedule/command/flags), and disable/enable (comment/uncomment lines).
|
||||||
- `-L [id] [filter]`: Query `journalctl` logs for managed jobs (both unit messages and command output). Optional job ID to filter to a single job.
|
- `-L [id|name] [filter]`: Query `journalctl` logs for managed jobs (both unit messages and command output). Optional job ID or name to filter to a single job.
|
||||||
- `-S [id]`: Show timer status via `systemctl`, including short IDs and disabled state. Optional job ID to show a single job.
|
- `-S [id|name]`: Show timer status via `systemctl`, including short IDs, names, and disabled state. Optional job ID or name to show a single job.
|
||||||
- `-C`: Interactively clean up elapsed one-time timers (removes unit files from disk).
|
- `-C`: Interactively clean up elapsed one-time timers (removes unit files from disk).
|
||||||
|
|
||||||
Key functions: `parse_time` (time spec → OnCalendar), `_write_unit_files` (shared service+timer creation), `create_job`/`create_job_from_edit` (thin wrappers), `edit_jobs` (crontab-style edit with diff-and-apply), `get_managed_units` (find tagged units by type), `clean_jobs` (remove elapsed one-time timers), `disable_job_by_id`/`enable_job_by_id` (disable/enable timers), `write_notify_lines` (append `ExecStopPost` notification lines), `build_flags_string`/`parse_flags` (convert between CLI options and flags format).
|
Key functions: `parse_time` (time spec → OnCalendar), `_write_unit_files` (shared service+timer creation), `create_job`/`create_job_from_edit` (thin wrappers), `edit_jobs` (crontab-style edit with diff-and-apply), `get_managed_units` (find tagged units by type), `clean_jobs` (remove elapsed one-time timers), `disable_job_by_id`/`enable_job_by_id` (disable/enable timers), `write_notify_lines` (append `ExecStopPost` notification lines), `build_flags_string`/`parse_flags` (convert between CLI options and flags format), `resolve_job_id` (resolve hex ID or name to hex ID).
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
|
|
@ -35,11 +35,13 @@ Key functions: `parse_time` (time spec → OnCalendar), `_write_unit_files` (sha
|
||||||
./test.sh
|
./test.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
Runs 44 tests against real systemd user timers covering job creation, status, logs, disable/enable, notifications, time format parsing, error cases, and cleanup. All test jobs are cleaned up automatically via trap.
|
Runs 58 tests against real systemd user timers covering job creation, job names, status, logs, disable/enable, notifications, time format parsing, error cases, and cleanup. All test jobs are cleaned up automatically via trap.
|
||||||
|
|
||||||
|
Tests require a real systemd user session (`systemctl --user`) and cannot run in containers. CI runs ShellCheck only; tests must be run locally before submitting changes.
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
- ShellCheck can be used for linting: `shellcheck systab`.
|
- ShellCheck can be used for linting: `shellcheck systab`.
|
||||||
- Edit mode uses `|` as the field delimiter (not tabs or spaces) to allow multi-word schedules. Notification flags use `:` after the ID (e.g., `a1b2c3:i,o,e=user@host`).
|
- Edit mode uses `|` as the field delimiter (not tabs or spaces) to allow multi-word schedules. Flags use `:` after the ID (e.g., `a1b2c3:n=backup,i,o,e=user@host`).
|
||||||
- Notification flags (`i` = desktop, `o`/`o=N` = include output, `e=addr` = email) are persisted as `# SYSTAB_FLAGS=...` comments in service files and as `ExecStopPost=` lines using `$SERVICE_RESULT`/`$EXIT_STATUS` for status-aware messages. Unit file `printf` format strings must use `%%s` (not `%s`) since systemd expands `%s` as a specifier before the shell runs.
|
- Flags (`i` = desktop, `o`/`o=N` = include output, `e=addr` = email, `n=name` = job name) are persisted as `# SYSTAB_FLAGS=...` comments in service files. Names are additionally stored as `# SYSTAB_NAME=...` comments. `ExecStopPost=` lines use `$SERVICE_RESULT`/`$EXIT_STATUS` for status-aware messages. Unit file `printf` format strings must use `%%s` (not `%s`) since systemd expands `%s` as a specifier before the shell runs.
|
||||||
- Journal logs are queried with `USER_UNIT` OR `SYSLOG_IDENTIFIER` to capture both systemd messages and command output.
|
- Journal logs are queried with `USER_UNIT` OR `SYSLOG_IDENTIFIER` to capture both systemd messages and command output.
|
||||||
|
|
|
||||||
661
LICENSE
Normal file
661
LICENSE
Normal file
|
|
@ -0,0 +1,661 @@
|
||||||
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU Affero General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works, specifically designed to ensure
|
||||||
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
our General Public Licenses are intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
Developers that use our General Public Licenses protect your rights
|
||||||
|
with two steps: (1) assert copyright on the software, and (2) offer
|
||||||
|
you this License which gives you legal permission to copy, distribute
|
||||||
|
and/or modify the software.
|
||||||
|
|
||||||
|
A secondary benefit of defending all users' freedom is that
|
||||||
|
improvements made in alternate versions of the program, if they
|
||||||
|
receive widespread use, become available for other developers to
|
||||||
|
incorporate. Many developers of free software are heartened and
|
||||||
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
|
software used on network servers, this result may fail to come about.
|
||||||
|
The GNU General Public License permits making a modified version and
|
||||||
|
letting the public access it on a server without ever releasing its
|
||||||
|
source code to the public.
|
||||||
|
|
||||||
|
The GNU Affero General Public License is designed specifically to
|
||||||
|
ensure that, in such cases, the modified source code becomes available
|
||||||
|
to the community. It requires the operator of a network server to
|
||||||
|
provide the source code of the modified version running there to the
|
||||||
|
users of that server. Therefore, public use of a modified version, on
|
||||||
|
a publicly accessible server, gives the public access to the source
|
||||||
|
code of the modified version.
|
||||||
|
|
||||||
|
An older license, called the Affero General Public License and
|
||||||
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
|
this license.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the
|
||||||
|
Program, your modified version must prominently offer all users
|
||||||
|
interacting with it remotely through a computer network (if your version
|
||||||
|
supports such interaction) an opportunity to receive the Corresponding
|
||||||
|
Source of your version by providing access to the Corresponding Source
|
||||||
|
from a network server at no charge, through some standard or customary
|
||||||
|
means of facilitating copying of software. This Corresponding Source
|
||||||
|
shall include the Corresponding Source for any work covered by version 3
|
||||||
|
of the GNU General Public License that is incorporated pursuant to the
|
||||||
|
following paragraph.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the work with which it is combined will remain governed by version
|
||||||
|
3 of the GNU General Public License.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU Affero General Public License from time to time. Such new versions
|
||||||
|
will be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU Affero General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU Affero General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU Affero General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If your software can interact with users remotely through a computer
|
||||||
|
network, you should also make sure that it provides a way for users to
|
||||||
|
get its source. For example, if your program is a web application, its
|
||||||
|
interface could display a "Source" link that leads users to an archive
|
||||||
|
of the code. There are many ways you could offer source, and different
|
||||||
|
solutions will be better for different programs; see section 13 for the
|
||||||
|
specific requirements.
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
54
README.md
54
README.md
|
|
@ -1,5 +1,8 @@
|
||||||
# systab
|
# systab
|
||||||
|
|
||||||
|
[](https://code.opennomad.com/opennomad/systab/actions?workflow=ci.yml)
|
||||||
|
[](LICENSE)
|
||||||
|
|
||||||
A cron/at-like interface for systemd user timers. Create, manage, and monitor scheduled jobs without writing unit files by hand.
|
A cron/at-like interface for systemd user timers. Create, manage, and monitor scheduled jobs without writing unit files by hand.
|
||||||
|
|
||||||
<table>
|
<table>
|
||||||
|
|
@ -28,11 +31,11 @@ Requires `bash`, `systemctl`, and optionally `notify-send` (for `-i`) and `sendm
|
||||||
## Quick start
|
## Quick start
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Run a command every 5 minutes
|
# Run a command every 5 minutes (with a name for easy reference)
|
||||||
systab -t "every 5 minutes" -c "curl -s https://example.com/health"
|
systab -t "every 5 minutes" -n healthcheck -c "curl -s https://example.com/health"
|
||||||
|
|
||||||
# Run a backup script every day at 2am
|
# Run a backup script every day at 2am
|
||||||
systab -t "every day at 2am" -f ~/backup.sh
|
systab -t "every day at 2am" -n backup -f ~/backup.sh
|
||||||
|
|
||||||
# Run a one-time command in 30 minutes
|
# Run a one-time command in 30 minutes
|
||||||
systab -t "in 30 minutes" -c "echo reminder"
|
systab -t "in 30 minutes" -c "echo reminder"
|
||||||
|
|
@ -59,7 +62,7 @@ systab accepts several time formats:
|
||||||
| Relative | `in 5 minutes` | One-time |
|
| Relative | `in 5 minutes` | One-time |
|
||||||
| Relative | `tomorrow` | One-time |
|
| Relative | `tomorrow` | One-time |
|
||||||
| Absolute | `2025-06-15 14:30` | One-time |
|
| Absolute | `2025-06-15 14:30` | One-time |
|
||||||
| Absolute | `next tuesday at noon` | One-time |
|
| Absolute | `next tuesday at 9am` | One-time |
|
||||||
| Systemd keyword | `hourly`, `daily`, `weekly`, `monthly` | Recurring |
|
| Systemd keyword | `hourly`, `daily`, `weekly`, `monthly` | Recurring |
|
||||||
| Systemd OnCalendar | `*:0/15` (every 15 min) | Recurring |
|
| Systemd OnCalendar | `*:0/15` (every 15 min) | Recurring |
|
||||||
| Systemd OnCalendar | `*-*-* 02:00:00` (daily at 2am) | Recurring |
|
| Systemd OnCalendar | `*-*-* 02:00:00` (daily at 2am) | Recurring |
|
||||||
|
|
@ -67,16 +70,18 @@ systab accepts several time formats:
|
||||||
|
|
||||||
Relative and absolute formats are parsed by `date -d`. Systemd OnCalendar values are passed through directly.
|
Relative and absolute formats are parsed by `date -d`. Systemd OnCalendar values are passed through directly.
|
||||||
|
|
||||||
|
Note: `date -d` does not technically like "*in* 5 minutes" or "*at*" between day and time. `systab` strips "in" and "at" before passing to `date -d`.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
### Creating jobs
|
### Creating jobs
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Command string
|
# Command string (with optional name)
|
||||||
systab -t "every 5 minutes" -c "echo hello"
|
systab -t "every 5 minutes" -n ping -c "echo hello"
|
||||||
|
|
||||||
# Script file
|
# Script file
|
||||||
systab -t "every day at 2am" -f ~/backup.sh
|
systab -t "every day at 2am" -n backup -f ~/backup.sh
|
||||||
|
|
||||||
# From stdin
|
# From stdin
|
||||||
echo "ls -la /tmp" | systab -t daily
|
echo "ls -la /tmp" | systab -t daily
|
||||||
|
|
@ -100,23 +105,23 @@ systab -e
|
||||||
# Show status of all jobs
|
# Show status of all jobs
|
||||||
systab -S
|
systab -S
|
||||||
|
|
||||||
# Show status of a specific job
|
# Show status of a specific job (by ID or name)
|
||||||
systab -S a1b2c3
|
systab -S a1b2c3
|
||||||
|
systab -S backup
|
||||||
|
|
||||||
# View logs (all jobs)
|
# View logs (all jobs)
|
||||||
systab -L
|
systab -L
|
||||||
|
|
||||||
# View logs for a specific job
|
# View logs for a specific job (by ID or name)
|
||||||
systab -L a1b2c3
|
systab -L a1b2c3
|
||||||
|
systab -L backup
|
||||||
|
|
||||||
# View logs (filtered)
|
# View logs (filtered)
|
||||||
systab -L error
|
systab -L error
|
||||||
|
|
||||||
# Disable a job
|
# Disable/enable a job (by ID or name)
|
||||||
systab -D <id>
|
systab -D backup
|
||||||
|
systab -E backup
|
||||||
# Enable a disabled job
|
|
||||||
systab -E <id>
|
|
||||||
|
|
||||||
# Clean up completed one-time jobs
|
# Clean up completed one-time jobs
|
||||||
systab -C
|
systab -C
|
||||||
|
|
@ -127,9 +132,9 @@ systab -C
|
||||||
`systab -e` opens your editor with a pipe-delimited job list:
|
`systab -e` opens your editor with a pipe-delimited job list:
|
||||||
|
|
||||||
```
|
```
|
||||||
a1b2c3 | daily | /home/user/backup.sh
|
a1b2c3:n=backup | daily | /home/user/backup.sh
|
||||||
d4e5f6:i | *:0/15 | curl -s https://example.com
|
d4e5f6:i | *:0/15 | curl -s https://example.com
|
||||||
g7h8i9:e=user@host | weekly | ~/backup.sh
|
g7h8i9:n=weekly-backup,e=user@host | weekly | ~/backup.sh
|
||||||
# aabbcc | hourly | echo "this job is disabled"
|
# aabbcc | hourly | echo "this job is disabled"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -137,11 +142,11 @@ g7h8i9:e=user@host | weekly | ~/backup.sh
|
||||||
- Delete a line to remove a job
|
- Delete a line to remove a job
|
||||||
- Add a line with `new` as the ID to create a job: `new | every 5 minutes | echo hello`
|
- Add a line with `new` as the ID to create a job: `new | every 5 minutes | echo hello`
|
||||||
- Comment out a line (`#`) to disable, uncomment to enable
|
- Comment out a line (`#`) to disable, uncomment to enable
|
||||||
- Append notification flags after the ID with `:` — `i` for desktop, `e=addr` for email, `o` for output (default 10 lines), `o=N` for custom count, comma-separated (e.g., `a1b2c3:i,o,e=user@host`)
|
- Append flags after the ID with `:` — `n=name` for naming, `i` for desktop notification, `e=addr` for email, `o` for output (default 10 lines), `o=N` for custom count, comma-separated (e.g., `a1b2c3:n=backup,i,o,e=user@host`)
|
||||||
|
|
||||||
### Job IDs
|
### Job IDs and names
|
||||||
|
|
||||||
Each job gets a 6-character hex ID (e.g., `a1b2c3`) displayed on creation and in status output. Use this ID with `-D`, `-E`, and `-L`.
|
Each job gets a 6-character hex ID (e.g., `a1b2c3`) displayed on creation and in status output. You can also assign a human-readable name with `-n` at creation time. Names can be used interchangeably with hex IDs in `-D`, `-E`, `-S`, and `-L`. Names must be unique and cannot contain whitespace, pipes, or colons.
|
||||||
|
|
||||||
## How it works
|
## How it works
|
||||||
|
|
||||||
|
|
@ -156,6 +161,7 @@ Job Creation:
|
||||||
-t <time> Time specification (required for job creation)
|
-t <time> Time specification (required for job creation)
|
||||||
-c <command> Command string to execute
|
-c <command> Command string to execute
|
||||||
-f <script> Script file to execute (reads stdin if neither -c nor -f)
|
-f <script> Script file to execute (reads stdin if neither -c nor -f)
|
||||||
|
-n <name> Give the job a human-readable name (usable in place of hex ID)
|
||||||
-i Send desktop notification on completion (success/failure)
|
-i Send desktop notification on completion (success/failure)
|
||||||
-m <email> Send email notification to address (via sendmail)
|
-m <email> Send email notification to address (via sendmail)
|
||||||
-o [lines] Include job output in notifications (default: 10 lines)
|
-o [lines] Include job output in notifications (default: 10 lines)
|
||||||
|
|
@ -170,6 +176,16 @@ Management:
|
||||||
-h Show help
|
-h Show help
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
AGPL-3.0-or-later. See [LICENSE](LICENSE).
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
The primary repository is hosted on [Forgejo](https://code.opennomad.com/opennomad/systab) with a public mirror on [GitHub](https://github.com/opennomad/systab).
|
||||||
|
|
||||||
|
Contributions (issues and pull requests) are welcome on GitHub.
|
||||||
|
|
||||||
## FAQ
|
## FAQ
|
||||||
|
|
||||||
**What's the difference between `-c` and `-f`?**
|
**What's the difference between `-c` and `-f`?**
|
||||||
|
|
|
||||||
|
|
@ -45,7 +45,7 @@ Down 5
|
||||||
Sleep 500ms
|
Sleep 500ms
|
||||||
|
|
||||||
# Add a new job line with notification flags
|
# Add a new job line with notification flags
|
||||||
Type "new:i,e=admin@example.com | hourly | curl -s https://example.com/health"
|
Type "new:n=health,i,e=admin@example.com | hourly | curl -s https://example.com/health"
|
||||||
Sleep 1s
|
Sleep 1s
|
||||||
Enter
|
Enter
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -54,7 +54,7 @@ Enter
|
||||||
Sleep 500ms
|
Sleep 500ms
|
||||||
Show
|
Show
|
||||||
Sleep 1s
|
Sleep 1s
|
||||||
Type "systab -t 'every day at 9am' -c '/home/user/backup.sh' -i -m admin@example.com"
|
Type "systab -t 'every day at 9am' -n backup -c '/home/user/backup.sh' -i -m admin@example.com"
|
||||||
Sleep 500ms
|
Sleep 500ms
|
||||||
Enter
|
Enter
|
||||||
Sleep 2s
|
Sleep 2s
|
||||||
|
|
|
||||||
|
|
@ -18,7 +18,7 @@ Enter
|
||||||
Sleep 500ms
|
Sleep 500ms
|
||||||
Show
|
Show
|
||||||
Sleep 1s
|
Sleep 1s
|
||||||
Type "systab -t 'every 5 minutes' -c 'echo health check OK'"
|
Type "systab -t 'every 5 minutes' -n healthcheck -c 'echo health check OK'"
|
||||||
Sleep 500ms
|
Sleep 500ms
|
||||||
Enter
|
Enter
|
||||||
Sleep 2s
|
Sleep 2s
|
||||||
|
|
@ -76,7 +76,7 @@ Enter
|
||||||
Sleep 500ms
|
Sleep 500ms
|
||||||
Show
|
Show
|
||||||
Sleep 1s
|
Sleep 1s
|
||||||
Type "systab -D $(systab -S 2>/dev/null | grep -m1 'Job:' | awk '{print $2}')"
|
Type "systab -D healthcheck"
|
||||||
Sleep 500ms
|
Sleep 500ms
|
||||||
Enter
|
Enter
|
||||||
Sleep 2s
|
Sleep 2s
|
||||||
|
|
@ -105,7 +105,7 @@ Enter
|
||||||
Sleep 500ms
|
Sleep 500ms
|
||||||
Show
|
Show
|
||||||
Sleep 1s
|
Sleep 1s
|
||||||
Type "systab -E $(systab -S 2>/dev/null | grep -m1 'Disabled' -B4 | grep 'Job:' | awk '{print $2}')"
|
Type "systab -E healthcheck"
|
||||||
Sleep 500ms
|
Sleep 500ms
|
||||||
Enter
|
Enter
|
||||||
Sleep 2s
|
Sleep 2s
|
||||||
|
|
|
||||||
183
systab
183
systab
|
|
@ -1,7 +1,9 @@
|
||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
|
# systab - A cron/at/batch-like interface for systemd
|
||||||
|
# Copyright (C) 2026 opennomad
|
||||||
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
|
|
||||||
# systab - A cron/at/batch-like interface for systemd
|
|
||||||
# Managed jobs are marked with: # SYSTAB_MANAGED
|
# Managed jobs are marked with: # SYSTAB_MANAGED
|
||||||
|
|
||||||
readonly SCRIPT_NAME="systab"
|
readonly SCRIPT_NAME="systab"
|
||||||
|
|
@ -22,6 +24,7 @@ opt_disable=""
|
||||||
opt_enable=""
|
opt_enable=""
|
||||||
opt_filter=""
|
opt_filter=""
|
||||||
opt_output=""
|
opt_output=""
|
||||||
|
opt_name=""
|
||||||
opt_jobid=""
|
opt_jobid=""
|
||||||
|
|
||||||
usage() {
|
usage() {
|
||||||
|
|
@ -34,6 +37,7 @@ Job Creation Options:
|
||||||
-t <time> Time specification (see TIME FORMATS below)
|
-t <time> Time specification (see TIME FORMATS below)
|
||||||
-c <command> Command string to execute
|
-c <command> Command string to execute
|
||||||
-f <script> Script file to execute
|
-f <script> Script file to execute
|
||||||
|
-n <name> Give the job a human-readable name (usable in place of hex ID)
|
||||||
-i Send desktop notification on completion (success/failure)
|
-i Send desktop notification on completion (success/failure)
|
||||||
-m <email> Send email notification to address (via sendmail)
|
-m <email> Send email notification to address (via sendmail)
|
||||||
-o [lines] Include job output in notifications (default: 10 lines)
|
-o [lines] Include job output in notifications (default: 10 lines)
|
||||||
|
|
@ -49,15 +53,15 @@ Management Options:
|
||||||
TIME FORMATS:
|
TIME FORMATS:
|
||||||
Natural: "every 5 minutes", "every day at 2am", "every monday at 9am"
|
Natural: "every 5 minutes", "every day at 2am", "every monday at 9am"
|
||||||
Relative: "in 5 minutes", "in 2 hours", "tomorrow"
|
Relative: "in 5 minutes", "in 2 hours", "tomorrow"
|
||||||
Absolute: "2025-01-21 14:30", "next tuesday at noon"
|
Absolute: "2025-01-21 14:30", "next tuesday at 9am"
|
||||||
Systemd: "daily", "weekly", "hourly", "*:0/15" (every 15 min)
|
Systemd: "daily", "weekly", "hourly", "*:0/15" (every 15 min)
|
||||||
|
|
||||||
EXAMPLES:
|
EXAMPLES:
|
||||||
# Run command every 5 minutes
|
# Run command every 5 minutes with a name
|
||||||
$SCRIPT_NAME -t "every 5 minutes" -c "echo Hello"
|
$SCRIPT_NAME -t "every 5 minutes" -n healthcheck -c "echo Hello"
|
||||||
|
|
||||||
# Run script every day at 2am with desktop notification
|
# Run script every day at 2am with desktop notification
|
||||||
$SCRIPT_NAME -t "every day at 2am" -f ~/backup.sh -i
|
$SCRIPT_NAME -t "every day at 2am" -n backup -f ~/backup.sh -i
|
||||||
|
|
||||||
# Run command with email notification
|
# Run command with email notification
|
||||||
$SCRIPT_NAME -t "in 5 minutes" -c "echo Hello" -m user@example.com
|
$SCRIPT_NAME -t "in 5 minutes" -c "echo Hello" -m user@example.com
|
||||||
|
|
@ -71,9 +75,9 @@ EXAMPLES:
|
||||||
# Edit existing jobs (supports adding notifications via ID:flags syntax)
|
# Edit existing jobs (supports adding notifications via ID:flags syntax)
|
||||||
$SCRIPT_NAME -e
|
$SCRIPT_NAME -e
|
||||||
|
|
||||||
# Disable and enable a job
|
# Disable and enable a job (by hex ID or name)
|
||||||
$SCRIPT_NAME -D <id>
|
$SCRIPT_NAME -D <id>
|
||||||
$SCRIPT_NAME -E <id>
|
$SCRIPT_NAME -E backup
|
||||||
|
|
||||||
# View logs for backup jobs
|
# View logs for backup jobs
|
||||||
$SCRIPT_NAME -L backup
|
$SCRIPT_NAME -L backup
|
||||||
|
|
@ -159,8 +163,10 @@ parse_time() {
|
||||||
|
|
||||||
# Try to parse with date command (one-time specs)
|
# Try to parse with date command (one-time specs)
|
||||||
# Strip "in " prefix for natural phrasing ("in 5 minutes" → "5 minutes")
|
# Strip "in " prefix for natural phrasing ("in 5 minutes" → "5 minutes")
|
||||||
|
# Strip " at " before times ("next tuesday at noon" → "next tuesday noon")
|
||||||
local date_spec="$time_spec"
|
local date_spec="$time_spec"
|
||||||
[[ "${date_spec,,}" == in\ * ]] && date_spec="${date_spec:3}"
|
[[ "${date_spec,,}" == in\ * ]] && date_spec="${date_spec:3}"
|
||||||
|
date_spec="${date_spec// at / }"
|
||||||
local parsed_date
|
local parsed_date
|
||||||
if parsed_date=$(date -d "$date_spec" '+%Y-%m-%d %H:%M:%S' 2>/dev/null); then
|
if parsed_date=$(date -d "$date_spec" '+%Y-%m-%d %H:%M:%S' 2>/dev/null); then
|
||||||
echo "$parsed_date"
|
echo "$parsed_date"
|
||||||
|
|
@ -209,35 +215,88 @@ enable_job() {
|
||||||
systemctl --user start "${1}.timer" 2>/dev/null || true
|
systemctl --user start "${1}.timer" 2>/dev/null || true
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# Resolve a job identifier (hex ID or name) to a 6-char hex ID
|
||||||
|
# Sets _resolved_id; errors if not found
|
||||||
|
resolve_job_id() {
|
||||||
|
local input="$1"
|
||||||
|
# Try as hex ID first
|
||||||
|
if [[ "$input" =~ ^[0-9a-f]{6}$ ]]; then
|
||||||
|
local timer_file="$SYSTEMD_USER_DIR/${SCRIPT_NAME}_${input}.timer"
|
||||||
|
if [[ -f "$timer_file" ]]; then
|
||||||
|
_resolved_id="$input"
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
# Try as name: grep service files for SYSTAB_NAME=<input>
|
||||||
|
local file
|
||||||
|
for file in "${SYSTEMD_USER_DIR}/${SCRIPT_NAME}"_*.service; do
|
||||||
|
[[ -f "$file" ]] || continue
|
||||||
|
if grep -q "^# SYSTAB_NAME=${input}$" "$file" 2>/dev/null; then
|
||||||
|
local base
|
||||||
|
base=$(basename "$file" .service)
|
||||||
|
_resolved_id=$(job_id "$base")
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
error "No job found with ID or name: $input"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Get the human-readable name from a service file (empty string if none)
|
||||||
|
get_job_name() {
|
||||||
|
local service_file="$1"
|
||||||
|
sed -n 's/^# SYSTAB_NAME=//p' "$service_file" 2>/dev/null || true
|
||||||
|
}
|
||||||
|
|
||||||
|
# Format a job identifier for display: "id (name)" or just "id"
|
||||||
|
format_job_id() {
|
||||||
|
local id="$1" name="$2"
|
||||||
|
if [[ -n "$name" ]]; then
|
||||||
|
echo "$id ($name)"
|
||||||
|
else
|
||||||
|
echo "$id"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
# Validate a short ID refers to a managed job, sets _job_name
|
# Validate a short ID refers to a managed job, sets _job_name
|
||||||
validate_job_id() {
|
validate_job_id() {
|
||||||
local id="$1"
|
resolve_job_id "$1"
|
||||||
|
local id="$_resolved_id"
|
||||||
_job_name="${SCRIPT_NAME}_${id}"
|
_job_name="${SCRIPT_NAME}_${id}"
|
||||||
local timer_file="$SYSTEMD_USER_DIR/${_job_name}.timer"
|
local timer_file="$SYSTEMD_USER_DIR/${_job_name}.timer"
|
||||||
[[ -f "$timer_file" ]] || error "No job found with ID: $id"
|
[[ -f "$timer_file" ]] || error "No job found with ID: $id"
|
||||||
grep -q "^$MARKER" "$timer_file" 2>/dev/null || error "Not a managed job: $id"
|
grep -q "^$MARKER" "$timer_file" 2>/dev/null || error "Not a managed job: $id"
|
||||||
}
|
}
|
||||||
|
|
||||||
# Disable a job by short ID
|
# Disable a job by short ID or name
|
||||||
disable_job_by_id() {
|
disable_job_by_id() {
|
||||||
validate_job_id "$1"
|
validate_job_id "$1"
|
||||||
|
local id="$_resolved_id"
|
||||||
|
local name
|
||||||
|
name=$(get_job_name "$SYSTEMD_USER_DIR/${_job_name}.service")
|
||||||
|
local label
|
||||||
|
label=$(format_job_id "$id" "$name")
|
||||||
if ! is_job_enabled "$_job_name"; then
|
if ! is_job_enabled "$_job_name"; then
|
||||||
echo "Already disabled: $1"
|
echo "Already disabled: $label"
|
||||||
return
|
return
|
||||||
fi
|
fi
|
||||||
disable_job "$_job_name"
|
disable_job "$_job_name"
|
||||||
echo "Disabled: $1"
|
echo "Disabled: $label"
|
||||||
}
|
}
|
||||||
|
|
||||||
# Enable a job by short ID
|
# Enable a job by short ID or name
|
||||||
enable_job_by_id() {
|
enable_job_by_id() {
|
||||||
validate_job_id "$1"
|
validate_job_id "$1"
|
||||||
|
local id="$_resolved_id"
|
||||||
|
local name
|
||||||
|
name=$(get_job_name "$SYSTEMD_USER_DIR/${_job_name}.service")
|
||||||
|
local label
|
||||||
|
label=$(format_job_id "$id" "$name")
|
||||||
if is_job_enabled "$_job_name"; then
|
if is_job_enabled "$_job_name"; then
|
||||||
echo "Already enabled: $1"
|
echo "Already enabled: $label"
|
||||||
return
|
return
|
||||||
fi
|
fi
|
||||||
enable_job "$_job_name"
|
enable_job "$_job_name"
|
||||||
echo "Enabled: $1"
|
echo "Enabled: $label"
|
||||||
}
|
}
|
||||||
|
|
||||||
# Get all managed unit files of a given type (service or timer)
|
# Get all managed unit files of a given type (service or timer)
|
||||||
|
|
@ -251,7 +310,7 @@ get_managed_units() {
|
||||||
done
|
done
|
||||||
}
|
}
|
||||||
|
|
||||||
# Build flags string from opt_notify and opt_email
|
# Build flags string from opt_notify, opt_email, and opt_name
|
||||||
build_flags_string() {
|
build_flags_string() {
|
||||||
local flags=""
|
local flags=""
|
||||||
if $opt_notify; then
|
if $opt_notify; then
|
||||||
|
|
@ -265,15 +324,20 @@ build_flags_string() {
|
||||||
[[ -n "$flags" ]] && flags+=","
|
[[ -n "$flags" ]] && flags+=","
|
||||||
flags+="e=$opt_email"
|
flags+="e=$opt_email"
|
||||||
fi
|
fi
|
||||||
|
if [[ -n "$opt_name" ]]; then
|
||||||
|
[[ -n "$flags" ]] && flags+=","
|
||||||
|
flags+="n=$opt_name"
|
||||||
|
fi
|
||||||
echo "$flags"
|
echo "$flags"
|
||||||
}
|
}
|
||||||
|
|
||||||
# Parse flags string into _notify_flag (bool) and _email_addr (string)
|
# Parse flags string into _notify_flag (bool), _email_addr (string), _name (string)
|
||||||
parse_flags() {
|
parse_flags() {
|
||||||
local flags="$1"
|
local flags="$1"
|
||||||
_notify_flag=false
|
_notify_flag=false
|
||||||
_email_addr=""
|
_email_addr=""
|
||||||
_output_lines=""
|
_output_lines=""
|
||||||
|
_name=""
|
||||||
IFS=',' read -ra parts <<< "$flags"
|
IFS=',' read -ra parts <<< "$flags"
|
||||||
for part in "${parts[@]}"; do
|
for part in "${parts[@]}"; do
|
||||||
case "$part" in
|
case "$part" in
|
||||||
|
|
@ -281,15 +345,18 @@ parse_flags() {
|
||||||
o) _output_lines=10 ;;
|
o) _output_lines=10 ;;
|
||||||
o=*) _output_lines="${part#o=}" ;;
|
o=*) _output_lines="${part#o=}" ;;
|
||||||
e=*) _email_addr="${part#e=}" ;;
|
e=*) _email_addr="${part#e=}" ;;
|
||||||
|
n=*) _name="${part#n=}" ;;
|
||||||
esac
|
esac
|
||||||
done
|
done
|
||||||
}
|
}
|
||||||
|
|
||||||
# Write ExecStopPost notification lines to a service file
|
# Write ExecStopPost notification lines to a service file
|
||||||
# Usage: write_notify_lines <short_id> <notify_flag> <email_addr> <file> [output_lines] [job_name]
|
# Usage: write_notify_lines <short_id> <notify_flag> <email_addr> <file> [output_lines] [job_name] [display_name]
|
||||||
write_notify_lines() {
|
write_notify_lines() {
|
||||||
local short_id="$1" notify="$2" email="$3" file="$4"
|
local short_id="$1" notify="$2" email="$3" file="$4"
|
||||||
local output_lines="${5-}" job_name="${6-}"
|
local output_lines="${5-}" job_name="${6-}" display_name="${7-}"
|
||||||
|
local job_label="$short_id"
|
||||||
|
[[ -n "$display_name" ]] && job_label="$short_id ($display_name)"
|
||||||
local out_cmd=""
|
local out_cmd=""
|
||||||
if [[ -n "$output_lines" && -n "$job_name" ]]; then
|
if [[ -n "$output_lines" && -n "$job_name" ]]; then
|
||||||
out_cmd="out=\$(journalctl --user SYSLOG_IDENTIFIER=$job_name -n $output_lines --no-pager -o cat); "
|
out_cmd="out=\$(journalctl --user SYSLOG_IDENTIFIER=$job_name -n $output_lines --no-pager -o cat); "
|
||||||
|
|
@ -302,9 +369,9 @@ write_notify_lines() {
|
||||||
if [[ "$notify" == true ]]; then
|
if [[ "$notify" == true ]]; then
|
||||||
local notify_cmd
|
local notify_cmd
|
||||||
if [[ -n "$out_cmd" ]]; then
|
if [[ -n "$out_cmd" ]]; then
|
||||||
notify_cmd="${out_cmd}body=\$(printf \"Job $short_id: %%s\n%%s\" \"\$s\" \"\$out\"); notify-send -i \"\$icon\" \"systab\" \"\$body\" || true"
|
notify_cmd="${out_cmd}body=\$(printf \"Job $job_label: %%s\n%%s\" \"\$s\" \"\$out\"); notify-send -i \"\$icon\" \"systab\" \"\$body\" || true"
|
||||||
else
|
else
|
||||||
notify_cmd="notify-send -i \"\$icon\" \"systab\" \"Job $short_id: \$s\" || true"
|
notify_cmd="notify-send -i \"\$icon\" \"systab\" \"Job $job_label: \$s\" || true"
|
||||||
fi
|
fi
|
||||||
echo "ExecStopPost=/bin/sh -c '${icon_pre}${notify_cmd}'" >> "$file"
|
echo "ExecStopPost=/bin/sh -c '${icon_pre}${notify_cmd}'" >> "$file"
|
||||||
fi
|
fi
|
||||||
|
|
@ -314,9 +381,9 @@ write_notify_lines() {
|
||||||
[[ -n "$mailer" ]] || { warn "No sendmail or msmtp found, skipping email notification"; return; }
|
[[ -n "$mailer" ]] || { warn "No sendmail or msmtp found, skipping email notification"; return; }
|
||||||
local mail_cmd
|
local mail_cmd
|
||||||
if [[ -n "$out_cmd" ]]; then
|
if [[ -n "$out_cmd" ]]; then
|
||||||
mail_cmd="${out_cmd}printf \"Subject: systab: $short_id %%s\\\\n\\\\n%%s at %%s\\\\n\\\\n%%s\\\\n\" \"\$s\" \"\$s\" \"\$(date)\" \"\$out\" | $mailer $email"
|
mail_cmd="${out_cmd}printf \"Subject: systab: $job_label %%s\\\\n\\\\n%%s at %%s\\\\n\\\\n%%s\\\\n\" \"\$s\" \"\$s\" \"\$(date)\" \"\$out\" | $mailer $email"
|
||||||
else
|
else
|
||||||
mail_cmd="printf \"Subject: systab: $short_id %%s\\\\n\\\\n%%s at %%s\\\\n\" \"\$s\" \"\$s\" \"\$(date)\" | $mailer $email"
|
mail_cmd="printf \"Subject: systab: $job_label %%s\\\\n\\\\n%%s at %%s\\\\n\" \"\$s\" \"\$s\" \"\$(date)\" | $mailer $email"
|
||||||
fi
|
fi
|
||||||
echo "ExecStopPost=/bin/sh -c '${status_pre}${mail_cmd}'" >> "$file"
|
echo "ExecStopPost=/bin/sh -c '${status_pre}${mail_cmd}'" >> "$file"
|
||||||
fi
|
fi
|
||||||
|
|
@ -352,7 +419,8 @@ EOF
|
||||||
if [[ -n "$flags" ]]; then
|
if [[ -n "$flags" ]]; then
|
||||||
echo "# SYSTAB_FLAGS=$flags" >> "$service_file"
|
echo "# SYSTAB_FLAGS=$flags" >> "$service_file"
|
||||||
parse_flags "$flags"
|
parse_flags "$flags"
|
||||||
write_notify_lines "$short_id" "$_notify_flag" "$_email_addr" "$service_file" "$_output_lines" "$job_name"
|
[[ -n "$_name" ]] && echo "# SYSTAB_NAME=$_name" >> "$service_file"
|
||||||
|
write_notify_lines "$short_id" "$_notify_flag" "$_email_addr" "$service_file" "$_output_lines" "$job_name" "$_name"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Timer file
|
# Timer file
|
||||||
|
|
@ -385,6 +453,19 @@ EOF
|
||||||
_created_id="$short_id"
|
_created_id="$short_id"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# Check that a job name is unique across all managed jobs
|
||||||
|
check_name_unique() {
|
||||||
|
local name="$1"
|
||||||
|
[[ -d "$SYSTEMD_USER_DIR" ]] || return
|
||||||
|
local file
|
||||||
|
for file in "${SYSTEMD_USER_DIR}/${SCRIPT_NAME}"_*.service; do
|
||||||
|
[[ -f "$file" ]] || continue
|
||||||
|
if grep -q "^# SYSTAB_NAME=${name}$" "$file" 2>/dev/null; then
|
||||||
|
error "Job name '$name' is already in use"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
# Create a job from CLI options
|
# Create a job from CLI options
|
||||||
create_job() {
|
create_job() {
|
||||||
local command_to_run
|
local command_to_run
|
||||||
|
|
@ -403,13 +484,20 @@ create_job() {
|
||||||
[[ -n "$command_to_run" ]] || error "No command provided"
|
[[ -n "$command_to_run" ]] || error "No command provided"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# Validate name uniqueness
|
||||||
|
if [[ -n "$opt_name" ]]; then
|
||||||
|
check_name_unique "$opt_name"
|
||||||
|
fi
|
||||||
|
|
||||||
local time_spec
|
local time_spec
|
||||||
time_spec=$(parse_time "$opt_time")
|
time_spec=$(parse_time "$opt_time")
|
||||||
|
|
||||||
_write_unit_files "$command_to_run" "$time_spec" "$(build_flags_string)"
|
_write_unit_files "$command_to_run" "$time_spec" "$(build_flags_string)"
|
||||||
systemctl --user daemon-reload
|
systemctl --user daemon-reload
|
||||||
|
|
||||||
echo "Job created: $_created_id"
|
local label
|
||||||
|
label=$(format_job_id "$_created_id" "$opt_name")
|
||||||
|
echo "Job created: $label"
|
||||||
local job_name="${SCRIPT_NAME}_${_created_id}"
|
local job_name="${SCRIPT_NAME}_${_created_id}"
|
||||||
echo "Next run: $(systemctl --user show "$job_name.timer" -p NextElapseUSecRealtime --value 2>/dev/null)"
|
echo "Next run: $(systemctl --user show "$job_name.timer" -p NextElapseUSecRealtime --value 2>/dev/null)"
|
||||||
}
|
}
|
||||||
|
|
@ -447,11 +535,12 @@ edit_jobs() {
|
||||||
# Add a line with "new" as ID to create a job: new | daily | /path/to/cmd
|
# Add a line with "new" as ID to create a job: new | daily | /path/to/cmd
|
||||||
# Comment out a line to disable, uncomment to re-enable.
|
# Comment out a line to disable, uncomment to re-enable.
|
||||||
#
|
#
|
||||||
# Notification flags (append to ID with ':'): i = desktop, e=addr = email,
|
# Flags (append to ID with ':'): i = desktop, e=addr = email,
|
||||||
# o = include output (default 10 lines), o=N = include N lines of output
|
# o = include output (default 10 lines), o=N = include N lines of output,
|
||||||
|
# n=name = human-readable name (usable in place of hex ID)
|
||||||
# a1b2c3:i | daily | cmd desktop notification
|
# a1b2c3:i | daily | cmd desktop notification
|
||||||
# a1b2c3:i,o | daily | cmd desktop with last 10 lines of output
|
# a1b2c3:i,o | daily | cmd desktop with last 10 lines of output
|
||||||
# a1b2c3:i,o=5 | daily | cmd desktop with last 5 lines of output
|
# a1b2c3:n=backup,i | daily | cmd named job with desktop notification
|
||||||
# a1b2c3:e=user@host | daily | cmd email notification
|
# a1b2c3:e=user@host | daily | cmd email notification
|
||||||
# a1b2c3:i,e=user@host | daily | cmd both
|
# a1b2c3:i,e=user@host | daily | cmd both
|
||||||
#
|
#
|
||||||
|
|
@ -736,13 +825,14 @@ HEADER
|
||||||
|
|
||||||
# Handle flags changes
|
# Handle flags changes
|
||||||
if [[ "$old_flags" != "$new_flags" && -f "$service_file" ]]; then
|
if [[ "$old_flags" != "$new_flags" && -f "$service_file" ]]; then
|
||||||
# Remove existing notification lines and flags comment
|
# Remove existing notification lines, flags comment, and name comment
|
||||||
sed -i '/^ExecStopPost=/d; /^# SYSTAB_FLAGS=/d' "$service_file"
|
sed -i '/^ExecStopPost=/d; /^# SYSTAB_FLAGS=/d; /^# SYSTAB_NAME=/d' "$service_file"
|
||||||
# Add new flags and notification lines
|
# Add new flags and notification lines
|
||||||
if [[ -n "$new_flags" ]]; then
|
if [[ -n "$new_flags" ]]; then
|
||||||
echo "# SYSTAB_FLAGS=$new_flags" >> "$service_file"
|
echo "# SYSTAB_FLAGS=$new_flags" >> "$service_file"
|
||||||
parse_flags "$new_flags"
|
parse_flags "$new_flags"
|
||||||
write_notify_lines "$id" "$_notify_flag" "$_email_addr" "$service_file" "$_output_lines" "$jname"
|
[[ -n "$_name" ]] && echo "# SYSTAB_NAME=$_name" >> "$service_file"
|
||||||
|
write_notify_lines "$id" "$_notify_flag" "$_email_addr" "$service_file" "$_output_lines" "$jname" "$_name"
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
@ -771,7 +861,8 @@ HEADER
|
||||||
build_job_list() {
|
build_job_list() {
|
||||||
_job_list=()
|
_job_list=()
|
||||||
if [[ -n "$opt_jobid" ]]; then
|
if [[ -n "$opt_jobid" ]]; then
|
||||||
_job_list+=("${SCRIPT_NAME}_${opt_jobid}")
|
resolve_job_id "$opt_jobid"
|
||||||
|
_job_list+=("${SCRIPT_NAME}_${_resolved_id}")
|
||||||
else
|
else
|
||||||
local job
|
local job
|
||||||
while IFS= read -r job; do
|
while IFS= read -r job; do
|
||||||
|
|
@ -798,7 +889,11 @@ show_status() {
|
||||||
local timer_file="$SYSTEMD_USER_DIR/${job}.timer"
|
local timer_file="$SYSTEMD_USER_DIR/${job}.timer"
|
||||||
local service_file="$SYSTEMD_USER_DIR/${job}.service"
|
local service_file="$SYSTEMD_USER_DIR/${job}.service"
|
||||||
|
|
||||||
echo "Job: $(job_id "$job")"
|
local id name label
|
||||||
|
id=$(job_id "$job")
|
||||||
|
name=$(get_job_name "$SYSTEMD_USER_DIR/${job}.service")
|
||||||
|
label=$(format_job_id "$id" "$name")
|
||||||
|
echo "Job: $label"
|
||||||
|
|
||||||
# Get schedule from timer file
|
# Get schedule from timer file
|
||||||
if [[ -f "$timer_file" ]]; then
|
if [[ -f "$timer_file" ]]; then
|
||||||
|
|
@ -871,7 +966,11 @@ list_logs() {
|
||||||
[[ -n "$opt_filter" ]] && grep_args=(--grep "$opt_filter")
|
[[ -n "$opt_filter" ]] && grep_args=(--grep "$opt_filter")
|
||||||
|
|
||||||
for job in "${_job_list[@]}"; do
|
for job in "${_job_list[@]}"; do
|
||||||
echo "=== Logs for $(job_id "$job") ==="
|
local id name label
|
||||||
|
id=$(job_id "$job")
|
||||||
|
name=$(get_job_name "$SYSTEMD_USER_DIR/${job}.service")
|
||||||
|
label=$(format_job_id "$id" "$name")
|
||||||
|
echo "=== Logs for $label ==="
|
||||||
|
|
||||||
if systemctl --user is-active "${job}.timer" &>/dev/null; then
|
if systemctl --user is-active "${job}.timer" &>/dev/null; then
|
||||||
echo "Status: Active"
|
echo "Status: Active"
|
||||||
|
|
@ -929,11 +1028,12 @@ clean_jobs() {
|
||||||
|
|
||||||
# Parse command-line options
|
# Parse command-line options
|
||||||
parse_options() {
|
parse_options() {
|
||||||
while getopts "t:c:f:im:oD:E:eLSCh" opt; do
|
while getopts "t:c:f:n:im:oD:E:eLSCh" opt; do
|
||||||
case $opt in
|
case $opt in
|
||||||
t) opt_time="$OPTARG" ;;
|
t) opt_time="$OPTARG" ;;
|
||||||
c) opt_command="$OPTARG" ;;
|
c) opt_command="$OPTARG" ;;
|
||||||
f) opt_file="$OPTARG" ;;
|
f) opt_file="$OPTARG" ;;
|
||||||
|
n) opt_name="$OPTARG" ;;
|
||||||
i) opt_notify=true ;;
|
i) opt_notify=true ;;
|
||||||
m) opt_email="$OPTARG" ;;
|
m) opt_email="$OPTARG" ;;
|
||||||
o) # Optional argument: peek at next arg for a number
|
o) # Optional argument: peek at next arg for a number
|
||||||
|
|
@ -962,8 +1062,8 @@ parse_options() {
|
||||||
# Check for trailing arguments after -S or -L
|
# Check for trailing arguments after -S or -L
|
||||||
if ($opt_list || $opt_status) && [[ $OPTIND -le $# ]]; then
|
if ($opt_list || $opt_status) && [[ $OPTIND -le $# ]]; then
|
||||||
local trailing="${!OPTIND}"
|
local trailing="${!OPTIND}"
|
||||||
# If it looks like a job ID and the job exists, use as job filter
|
# Try to resolve as job ID or name (run in subshell to catch error exit)
|
||||||
if [[ "$trailing" =~ ^[0-9a-f]{6}$ ]] && [[ -f "$SYSTEMD_USER_DIR/${SCRIPT_NAME}_${trailing}.timer" ]]; then
|
if (resolve_job_id "$trailing") 2>/dev/null; then
|
||||||
opt_jobid="$trailing"
|
opt_jobid="$trailing"
|
||||||
# For -L, check for a second trailing arg as text filter
|
# For -L, check for a second trailing arg as text filter
|
||||||
if $opt_list; then
|
if $opt_list; then
|
||||||
|
|
@ -973,10 +1073,17 @@ parse_options() {
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
elif $opt_list; then
|
elif $opt_list; then
|
||||||
# Not a job ID — treat as text filter for backward compatibility
|
# Not a job ID or name — treat as text filter for backward compatibility
|
||||||
opt_filter="$trailing"
|
opt_filter="$trailing"
|
||||||
else
|
else
|
||||||
error "No job found with ID: $trailing"
|
error "No job found with ID or name: $trailing"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Validate name format
|
||||||
|
if [[ -n "$opt_name" ]]; then
|
||||||
|
if [[ "$opt_name" =~ [[:space:]|:] ]]; then
|
||||||
|
error "Job name must not contain whitespace, pipes, or colons"
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
|
||||||
35
test.sh
35
test.sh
|
|
@ -94,9 +94,9 @@ assert_file_contains() {
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
# Extract job ID from "Job created: <id>" output
|
# Extract job ID from "Job created: <id>" or "Job created: <id> (<name>)" output
|
||||||
extract_id() {
|
extract_id() {
|
||||||
sed -n 's/^Job created: \([0-9a-f]\{6\}\)$/\1/p' <<< "$_last_output"
|
sed -n 's/^Job created: \([0-9a-f]\{6\}\)\( .*\)\{0,1\}$/\1/p' <<< "$_last_output"
|
||||||
}
|
}
|
||||||
|
|
||||||
# Remove all systab_* unit files and reload
|
# Remove all systab_* unit files and reload
|
||||||
|
|
@ -271,6 +271,37 @@ assert_success "parse_time 'in 5 minutes' succeeds" bash -c '
|
||||||
parse_time "in 5 minutes"
|
parse_time "in 5 minutes"
|
||||||
'
|
'
|
||||||
|
|
||||||
|
# ============================================================
|
||||||
|
# Job names (-n)
|
||||||
|
# ============================================================
|
||||||
|
|
||||||
|
echo ""
|
||||||
|
echo "${BOLD}--- Job names ---${RESET}"
|
||||||
|
|
||||||
|
assert_output "create job with name" "Job created:" $SYSTAB -t "every 10 minutes" -c "echo named_test" -n mytest
|
||||||
|
id_named=$(extract_id)
|
||||||
|
assert_last_output_contains "name appears in creation output" "(mytest)"
|
||||||
|
|
||||||
|
assert_file_contains "service file has SYSTAB_NAME" \
|
||||||
|
"$SYSTEMD_USER_DIR/systab_${id_named}.service" "^# SYSTAB_NAME=mytest$"
|
||||||
|
|
||||||
|
assert_output "status by name" "(mytest)" $SYSTAB -S mytest
|
||||||
|
assert_output "logs by name" "(mytest)" $SYSTAB -L mytest
|
||||||
|
|
||||||
|
assert_output "disable by name" "Disabled:" $SYSTAB -D mytest
|
||||||
|
assert_last_output_contains "disable output shows name" "(mytest)"
|
||||||
|
|
||||||
|
assert_output "enable by name" "Enabled:" $SYSTAB -E mytest
|
||||||
|
assert_last_output_contains "enable output shows name" "(mytest)"
|
||||||
|
|
||||||
|
assert_output "status shows name" "(mytest)" $SYSTAB -S
|
||||||
|
|
||||||
|
assert_failure "duplicate name rejected" $SYSTAB -t "every 10 minutes" -c "echo dup" -n mytest
|
||||||
|
|
||||||
|
assert_failure "name with whitespace rejected" $SYSTAB -t "daily" -c "echo bad" -n "my test"
|
||||||
|
assert_failure "name with pipe rejected" $SYSTAB -t "daily" -c "echo bad" -n "my|test"
|
||||||
|
assert_failure "name with colon rejected" $SYSTAB -t "daily" -c "echo bad" -n "my:test"
|
||||||
|
|
||||||
# ============================================================
|
# ============================================================
|
||||||
# Error cases
|
# Error cases
|
||||||
# ============================================================
|
# ============================================================
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue