Create Group¶
The groups create command creates a new group from inline parameters or a JSON definition file.
Modes¶
| Mode | When to Use |
|---|---|
| Inline | Quick group creation โ pass all fields as CLI flags. |
File (--file) |
Complex or repeatable definitions โ provide a JSON file. |
Both modes are mutually exclusive. If --file is provided, all inline parameters are ignored.
Parameters¶
File Mode¶
| Parameter | Description |
|---|---|
--file, -f |
JSON file with group definition. |
Inline Parameters¶
| Parameter | Required | Description |
|---|---|---|
--name, -n |
Yes | Group name. |
--description, -d |
No | Group description. |
--active / --inactive |
No | Active status (default: --active). |
--timezone, -z |
No | Timezone in IANA format (e.g. UTC, America/New_York). |
--trigger-times |
No | Comma-separated times in HH:MM format (e.g. 09:00,14:30). Automatically deduplicated and sorted. |
--day-of-week |
No | 7-character binary string for MTWTFSS (e.g. 1111100 = MonโFri). |
--ordinal-day |
No | Ordinal day description (e.g. first monday of every month). |
--run-frequency |
No | Run frequency in HH:MM-HH:MM-freq format (e.g. 00:00-23:59-60). |
--calendar |
No | Calendar name (must exist in the backend). |
--dependency |
No | Dependency string (e.g. S:groupname). |
--profile |
No | Profile name. |
Mutual Exclusivity
- Only one of
--trigger-timesor--run-frequencymay be provided (not both). - Only one of
--day-of-weekor--ordinal-daymay be provided (not both).
๐ฅ๏ธ Basic Usage¶
Usage: easytask groups create [OPTIONS]
Create a group from inline parameters or a JSON file.
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
โ --file -f PATH JSON file with group definition โ
โ --name -n TEXT Group name (required if no --file) โ
โ --description -d TEXT Group description โ
โ --active / --inactive Active status (default: active) โ
โ --timezone -z TEXT Timezone, e.g. UTC โ
โ --trigger-times TEXT Comma-separated HH:MM โ
โ --day-of-week TEXT 7-char binary MTWTFSS โ
โ --ordinal-day TEXT Ordinal day โ
โ --run-frequency TEXT HH:MM-HH:MM-freq โ
โ --calendar TEXT Calendar name โ
โ --dependency TEXT Dependency string โ
โ --profile TEXT Profile name โ
โ --help -h Show this message and exit. โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
Inline Mode Examples¶
Create a basic group¶
easytask groups create \
--name "daily_jobs" \
--description "Daily batch processing jobs" \
--trigger-times "09:00" \
--day-of-week "1111100" \
--timezone "UTC"
Create a group with multiple trigger times¶
Trigger times are automatically deduplicated and sorted:
easytask groups create \
--name "etl_pipelines" \
--description "ETL pipelines" \
--trigger-times "18:00,07:00,12:00" \
--day-of-week "1111100" \
--timezone "America/New_York"
Create a group with run frequency¶
easytask groups create \
--name "high_freq_checks" \
--description "High-frequency health checks" \
--run-frequency "08:00-20:00-30" \
--day-of-week "1111111" \
--timezone "Asia/Kolkata"
Create a group with dependency¶
easytask groups create \
--name "dependent_jobs" \
--description "Runs after daily_jobs completes" \
--trigger-times "10:00" \
--day-of-week "1111100" \
--timezone "UTC" \
--dependency "S:daily_jobs"
Create an inactive group¶
easytask groups create \
--name "maintenance" \
--description "Disabled maintenance group" \
--trigger-times "02:00" \
--day-of-week "0000001" \
--timezone "UTC" \
--inactive
File Mode Examples¶
Group Schema
Sample Input¶
group_def.json
{
"name": "daily_jobs",
"day_of_week": "1111100",
"description": "Daily batch processing jobs",
"timezone": "UTC",
"trigger_times": "06:00",
"active": true
}