repository
stringclasses
528 values
commit
stringlengths
40
40
commitDate
timestamp[s]
path
stringlengths
11
149
repoStars
int64
5
94.9k
repoLastFetched
stringclasses
528 values
content
stringlengths
48
736k
license
stringclasses
14 values
language
stringclasses
7 values
heroiclabs/hiro
d7b50b0be46c97fddf61bde671486233c34f7b69
2023-12-21T15:04:37
schemas/13-Hiro-Incentives.json
16
2024-05-27T08:54:23.844076Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "incentives": { "patternProperties": { ".{1,}": { "properties": { "description": { "title": "description", "type": "string" }, "expiry_duration_sec": { "minimum": 0, "title": "expiry_duration_sec", "type": "integer" }, "max_claims": { "minimum": 0, "title": "max_claims", "type": "integer" }, "max_concurrent": { "minimum": 0, "title": "max_concurrent", "type": "integer" }, "max_global_claims": { "minimum": 0, "title": "max_global_claims", "type": "integer" }, "max_recipient_age_sec": { "minimum": 0, "title": "max_recipient_age_sec", "type": "integer" }, "name": { "title": "name", "type": "string" }, "recipient_reward": { "$ref": "Hiro-Rewards", "title": "recipient_reward" }, "sender_reward": { "$ref": "Hiro-Rewards", "title": "sender_reward" }, "type": { "minimum": 0, "title": "type", "type": "integer" } }, "required": [ "type", "name", "max_claims", "max_global_claims", "expiry_duration_sec" ], "type": "object" } }, "title": "incentives", "type": "object" } }, "required": [ "incentives" ] }
Apache-2.0
en
heroiclabs/hiro
d3dbe198614ad83f63b21c7b63d83a34682f5762
2023-07-10T10:49:48
schemas/02-Hiro-Rewards.json
16
2024-05-27T08:54:23.844076Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "guaranteed": { "$ref": "Hiro-Reward", "title": "guaranteed" }, "max_rolls": { "minimum": 0, "title": "max_rolls", "type": "number" }, "total_weight": { "minimum": 0, "title": "total_weight", "type": "number" }, "weighted": { "items": { "$ref": "Hiro-Reward" }, "title": "weighted", "type": "array" } }, "type": "object" }
Apache-2.0
en
heroiclabs/hiro
2f4efb9704c183fcadf632ae38824bfe3a310cdc
2024-05-17T13:03:18
schemas/09-Hiro-Economy.json
16
2024-05-27T08:54:23.844076Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "donations": { "patternProperties": { ".{1,}": { "properties": { "additional_properties": { "patternProperties": { ".{1,}": { "type": "string" } }, "type": "object" }, "contributor_reward": { "$ref": "Hiro-Rewards" }, "cost": { "properties": { "currencies": { "patternProperties": { ".{1,}": { "minimum": 0, "type": "number" } }, "type": "object" }, "items": { "patternProperties": { ".{1,}": { "minimum": 0, "type": "number" } }, "type": "object" } }, "type": "object" }, "count": { "minimum": 0, "type": "number" }, "description": { "pattern": ".*", "type": "string" }, "max_count": { "minimum": 0, "type": "number" }, "name": { "pattern": ".{1,}", "type": "string" }, "recipient_reward": { "$ref": "Hiro-Rewards" }, "user_contribution_max_count": { "minimum": 0, "type": "number" } }, "required": [ "name", "max_count" ], "type": "object" } }, "type": "object" }, "initialize_user": { "properties": { "currencies": { "patternProperties": { ".{1,}": { "minimum": 0, "type": "number" } }, "type": "object" }, "items": { "patternProperties": { ".{1,}": { "minimum": 0, "type": "number" } }, "type": "object" } }, "type": "object" }, "placements": { "patternProperties": { ".{1,}": { "properties": { "additional_properties": { "patternProperties": { ".{1,}": { "type": "string" } }, "type": "object" }, "reward": { "$ref": "Hiro-Rewards" } }, "type": "object" } }, "type": "object" }, "store_items": { "patternProperties": { ".{1,}": { "properties": { "additional_properties": { "patternProperties": { ".{1,}": { "type": "string" } }, "type": "object" }, "category": { "pattern": ".{1,}", "type": "string" }, "cost": { "properties": { "currencies": { "patternProperties": { ".{1,}": { "minimum": 0, "type": "number" } }, "type": "object" }, "sku": { "pattern": ".{1,}", "type": "string" } }, "type": "object" }, "description": { "pattern": ".*", "type": "string" }, "disabled": { "type": "boolean" }, "name": { "pattern": ".{1,}", "type": "string" }, "reward": { "$ref": "Hiro-Rewards" } }, "required": [ "name", "category" ], "type": "object" } }, "type": "object" } }, "type": "object" }
Apache-2.0
en
heroiclabs/hiro
ae6f4be47a00a79a806cea054783e5635d94770c
2024-05-16T22:07:07
schemas/01-Hiro-Reward.json
16
2024-05-27T08:54:23.844076Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "currencies": { "patternProperties": { ".{1,}": { "properties": { "max": { "minimum": 0, "type": "number" }, "min": { "minimum": 0, "type": "number" }, "multiple": { "minimum": 0, "type": "number" } }, "required": [ "min", "max" ], "type": "object" } }, "type": "object" }, "energies": { "patternProperties": { ".{1,}": { "properties": { "max": { "minimum": 0, "type": "number" }, "min": { "minimum": 0, "type": "number" }, "multiple": { "minimum": 0, "type": "number" } }, "required": [ "min", "max" ], "type": "object" } }, "type": "object" }, "energy_modifiers": { "items": { "properties": { "duration_sec": { "properties": { "max": { "minimum": 0, "type": "number" }, "min": { "minimum": 0, "type": "number" }, "multiple": { "minimum": 0, "type": "number" } }, "required": [ "min", "max" ], "type": "object" }, "id": { "pattern": ".{1,}", "type": "string" }, "operator": { "enum": [ "infinite" ], "type": "string" } }, "required": [ "id", "operator", "duration_sec" ], "type": "object" }, "type": "array" }, "item_sets": { "items": { "properties": { "max": { "minimum": 0, "type": "number" }, "max_repeats": { "minimum": 0, "type": "number" }, "min": { "minimum": 0, "type": "number" }, "multiple": { "minimum": 0, "type": "number" }, "set": { "items": { "pattern": ".{1,}", "type": "string" }, "type": "array" } }, "required": [ "min", "max", "set" ], "type": "object" }, "type": "array" }, "items": { "patternProperties": { ".{1,}": { "properties": { "max": { "minimum": 0, "type": "number" }, "min": { "minimum": 0, "type": "number" }, "multiple": { "minimum": 0, "type": "number" }, "numeric_properties": { "patternProperties": { ".{1,}": { "properties": { "max": { "type": "number" }, "min": { "type": "number" }, "multiple": { "minimum": 0, "type": "number" } }, "required": [ "min", "max" ] } }, "type": "object" }, "string_properties": { "patternProperties": { ".{1,}": { "properties": { "options": { "patternProperties": { ".{1,}": { "properties": { "weight": { "minimum": 0, "type": "number" } } } }, "type": "object" }, "total_weight": { "minimum": 0, "type": "number" } } } }, "type": "object" } }, "required": [ "min", "max" ], "type": "object" } }, "type": "object" }, "reward_modifiers": { "items": { "properties": { "duration_sec": { "properties": { "max": { "minimum": 0, "type": "number" }, "min": { "minimum": 0, "type": "number" }, "multiple": { "minimum": 0, "type": "number" } }, "required": [ "min", "max" ], "type": "object" }, "id": { "pattern": ".{1,}", "type": "string" }, "operator": { "enum": [ "multiplier", "addition" ], "type": "string" }, "type": { "enum": [ "currency", "item" ], "type": "string" }, "value": { "properties": { "max": { "minimum": 0, "type": "number" }, "min": { "minimum": 0, "type": "number" }, "multiple": { "minimum": 0, "type": "number" } }, "required": [ "min", "max" ], "type": "object" } }, "required": [ "id", "type", "operator", "value", "duration_sec" ], "type": "object" }, "type": "array" }, "weight": { "minimum": 0, "type": "number" } }, "type": "object" }
Apache-2.0
en
heroiclabs/hiro
e47d54f810f2ab7ca2eede973bd2204c8b0b069b
2024-05-23T20:07:13
schemas/07-Hiro-Inventory.json
16
2024-05-27T08:54:23.844076Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "items": { "patternProperties": { ".{1,}": { "properties": { "category": { "pattern": ".{1,}", "type": "string" }, "consumable": { "type": "boolean" }, "consume_reward": { "$ref": "Hiro-Rewards" }, "description": { "pattern": ".*", "type": "string" }, "disabled": { "type": "boolean" }, "item_sets": { "items": { "pattern": ".{1,}", "type": "string" }, "type": "array" }, "max_count": { "minimum": 0, "type": "number" }, "name": { "pattern": ".{1,}", "type": "string" }, "numeric_properties": { "patternProperties": { ".{1,}": { "type": "number" } }, "type": "object" }, "stackable": { "type": "boolean" }, "string_properties": { "patternProperties": { ".{1,}": { "pattern": ".{1,}", "type": "string" } }, "type": "object" } }, "required": [ "name", "category" ], "type": "object" } }, "type": "object" } }, "type": "object" }
Apache-2.0
en
heroiclabs/hiro
c4ee2f5cd52409f28c0efa6f325140139fee7116
2024-05-16T22:07:07
schemas/15-Hiro-Stats.json
16
2024-05-27T08:54:23.844076Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "whitelist": { "items": { "type": "string" }, "type": "array" } }, "required": [ "whitelist" ], "type": "object" }
Apache-2.0
en
heroiclabs/hiro
d7b50b0be46c97fddf61bde671486233c34f7b69
2023-12-21T15:04:37
schemas/12-Hiro-Event-Leaderboards.json
16
2024-05-27T08:54:23.844076Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "event_leaderboards": { "patternProperties": { ".+": { "properties": { "additional_properties": { "patternProperties": { ".+": { "type": "string" } }, "title": "additional_properties", "type": "object" }, "ascending": { "title": "ascending", "type": "boolean" }, "category": { "pattern": ".+", "title": "category", "type": "string" }, "change_zones": { "patternProperties": { "[0-9]+": { "properties": { "demote_idle": { "title": "demote_idle", "type": "boolean" }, "demotion": { "minimum": 0, "title": "demotion", "type": "number" }, "promotion": { "minimum": 0, "title": "promotion", "type": "number" } }, "type": "object" } }, "title": "change_zones", "type": "object" }, "cohort_size": { "minimum": 1, "title": "cohort_size", "type": "number" }, "description": { "pattern": ".+", "title": "description", "type": "string" }, "duration": { "minimum": 0, "title": "duration", "type": "number" }, "end_time_sec": { "minimum": 0, "title": "end_time_sec", "type": "number" }, "max_idle_tier_drop": { "minimum": 0, "title": "max_idle_tier_drop", "type": "number" }, "max_num_score": { "minimum": 0, "title": "max_num_score", "type": "number" }, "name": { "pattern": ".+", "title": "name", "type": "string" }, "operator": { "enum": [ "best", "set", "incr", "decr", "increment", "decrement" ], "title": "operator", "type": "string" }, "reset_schedule": { "title": "reset_schedule", "type": "string" }, "reward_tiers": { "patternProperties": { "[0-9]+": { "items": { "properties": { "name": { "title": "name", "type": "string" }, "rank_max": { "minimum": 0, "title": "rank_max", "type": "number" }, "rank_min": { "minimum": 0, "title": "rank_min", "type": "number" }, "reward": { "$ref": "Hiro-Rewards", "title": "reward" }, "tier_change": { "minimum": 0, "title": "tier_change", "type": "number" } }, "type": "object" }, "type": "array" } }, "title": "reward_tiers", "type": "object" }, "start_time_sec": { "minimum": 0, "title": "start_time_sec", "type": "number" }, "tiers": { "minimum": 1, "title": "tiers", "type": "number" } }, "type": "object" } }, "title": "event_leaderboards", "type": "object" } }, "required": [ "event_leaderboards" ], "type": "object" }
Apache-2.0
en
heroiclabs/hiro
2f4efb9704c183fcadf632ae38824bfe3a310cdc
2024-05-17T13:03:18
schemas/11-Hiro-Unlockables.json
16
2024-05-27T08:54:23.844076Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "active_slots": { "minimum": 0, "type": "number" }, "max_active_slots": { "minimum": 0, "type": "number" }, "slot_cost": { "properties": { "currencies": { "patternProperties": { ".{1,}": { "minimum": 0, "type": "number" } }, "type": "object" }, "items": { "patternProperties": { ".{1,}": { "minimum": 0, "type": "number" } }, "type": "object" } }, "type": "object" }, "slots": { "minimum": 0, "type": "number" }, "unlockables": { "patternProperties": { ".{1,}": { "properties": { "additional_properties": { "patternProperties": { ".{1,}": { "type": "string" } }, "type": "object" }, "category": { "pattern": ".{1,}", "type": "string" }, "cost": { "properties": { "currencies": { "patternProperties": { ".{1,}": { "minimum": 0, "type": "number" } }, "type": "object" }, "items": { "patternProperties": { ".{1,}": { "minimum": 0, "type": "number" } }, "type": "object" } }, "type": "object" }, "cost_unit_time_sec": { "minimum": 0, "type": "number" }, "description": { "pattern": ".*", "type": "string" }, "name": { "pattern": ".{1,}", "type": "string" }, "probability": { "minimum": 0, "type": "number" }, "reward": { "$ref": "Hiro-Rewards" }, "start_cost": { "properties": { "currencies": { "patternProperties": { ".{1,}": { "minimum": 0, "type": "number" } }, "type": "object" }, "items": { "patternProperties": { ".{1,}": { "minimum": 0, "type": "number" } }, "type": "object" } }, "type": "object" }, "wait_time_sec": { "minimum": 0, "type": "number" } }, "required": [ "probability", "category", "name" ], "type": "object" } }, "type": "object" } }, "required": [ "active_slots", "max_active_slots", "slots", "unlockables" ], "type": "object" }
Apache-2.0
en
heroiclabs/hiro
8ad2277f1636cc77966bcf223bc70dcde7966521
2023-09-07T11:29:08
schemas/12-Hiro-Event-Leaderboards.json
16
2024-05-27T08:54:23.844076Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "event_leaderboards": { "patternProperties": { ".+": { "properties": { "additional_properties": { "patternProperties": { ".+": { "type": "string" } }, "title": "additional_properties", "type": "object" }, "ascending": { "title": "ascending", "type": "boolean" }, "category": { "pattern": ".+", "title": "category", "type": "string" }, "change_zones": { "patternProperties": { "[0-9]+": { "properties": { "demote_idle": { "title": "demote_idle", "type": "boolean" }, "demotion": { "minimum": 0, "title": "demotion", "type": "number" }, "promotion": { "minimum": 0, "title": "promotion", "type": "number" } }, "type": "object" } }, "title": "change_zones", "type": "object" }, "cohort_size": { "minimum": 1, "title": "cohort_size", "type": "number" }, "description": { "pattern": ".+", "title": "description", "type": "string" }, "duration": { "minimum": 0, "title": "duration", "type": "number" }, "end_time_sec": { "minimum": 0, "title": "end_time_sec", "type": "number" }, "max_idle_tier_drop": { "minimum": 0, "title": "max_idle_tier_drop", "type": "number" }, "max_num_score": { "minimum": 0, "title": "max_num_score", "type": "number" }, "name": { "pattern": ".+", "title": "name", "type": "string" }, "operator": { "enum": [ "best", "set", "incr", "decr", "increment", "decrement" ], "title": "operator", "type": "string" }, "reset_schedule": { "title": "reset_schedule", "type": "string" }, "reward_tiers": { "patternProperties": { "[0-9]+": { "items": { "properties": { "rank_max": { "minimum": 0, "title": "rank_max", "type": "number" }, "rank_min": { "minimum": 0, "title": "rank_min", "type": "number" }, "reward": { "$ref": "Hiro-Rewards", "title": "reward" }, "tier_change": { "minimum": 0, "title": "tier_change", "type": "number" } }, "type": "object" }, "type": "array" } }, "title": "reward_tiers", "type": "object" }, "start_time_sec": { "minimum": 0, "title": "start_time_sec", "type": "number" }, "tiers": { "minimum": 1, "title": "tiers", "type": "number" } }, "type": "object" } }, "title": "event_leaderboards", "type": "object" } }, "required": [ "event_leaderboards" ], "type": "object" }
Apache-2.0
en
heroiclabs/hiro
d3dbe198614ad83f63b21c7b63d83a34682f5762
2023-07-10T10:49:48
schemas/01-Hiro-Reward.json
16
2024-05-27T08:54:23.844076Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "currencies": { "patternProperties": { ".{1,}": { "properties": { "max": { "minimum": 0, "title": "max", "type": "number" }, "min": { "minimum": 0, "title": "min", "type": "number" }, "multiple": { "minimum": 0, "title": "multiple", "type": "number" } }, "required": [ "min", "max" ], "title": "id", "type": "object" } }, "title": "currencies", "type": "object" }, "energies": { "patternProperties": { ".{1,}": { "properties": { "max": { "minimum": 0, "title": "max", "type": "number" }, "min": { "minimum": 0, "title": "min", "type": "number" }, "multiple": { "minimum": 0, "title": "multiple", "type": "number" } }, "required": [ "min", "max" ], "title": "id", "type": "object" } }, "title": "energies", "type": "object" }, "energy_modifiers": { "items": { "properties": { "duration_sec": { "properties": { "max": { "minimum": 0, "title": "max", "type": "number" }, "min": { "minimum": 0, "title": "min", "type": "number" }, "multiple": { "minimum": 0, "title": "multiple", "type": "number" } }, "required": [ "min", "max" ], "type": "object" }, "id": { "pattern": ".{1,}", "title": "id", "type": "string" }, "operator": { "enum": [ "infinite" ], "title": "operator", "type": "string" } }, "required": [ "id", "operator", "duration_sec" ], "type": "object" }, "title": "energy_modifiers", "type": "array" }, "item_sets": { "items": { "properties": { "max": { "minimum": 0, "title": "max", "type": "number" }, "max_repeats": { "minimum": 0, "title": "max_repeats", "type": "number" }, "min": { "minimum": 0, "title": "min", "type": "number" }, "multiple": { "minimum": 0, "title": "multiple", "type": "number" }, "set": { "items": { "pattern": ".{1,}", "type": "string" }, "title": "set", "type": "array" } }, "required": [ "min", "max", "set" ], "type": "object" }, "title": "item_sets", "type": "array" }, "items": { "patternProperties": { ".{1,}": { "properties": { "max": { "minimum": 0, "title": "max", "type": "number" }, "min": { "minimum": 0, "title": "min", "type": "number" }, "multiple": { "minimum": 0, "title": "multiple", "type": "number" } }, "required": [ "min", "max" ], "title": "id", "type": "object" } }, "title": "items", "type": "object" }, "reward_modifiers": { "items": { "properties": { "duration_sec": { "properties": { "max": { "minimum": 0, "title": "max", "type": "number" }, "min": { "minimum": 0, "title": "min", "type": "number" }, "multiple": { "minimum": 0, "title": "multiple", "type": "number" } }, "required": [ "min", "max" ], "title": "duration_sec", "type": "object" }, "id": { "pattern": ".{1,}", "title": "id", "type": "string" }, "operator": { "enum": [ "multiplier", "addition" ], "title": "operator", "type": "string" }, "type": { "enum": [ "currency", "item" ], "title": "type", "type": "string" }, "value": { "properties": { "max": { "minimum": 0, "title": "max", "type": "number" }, "min": { "minimum": 0, "title": "min", "type": "number" }, "multiple": { "minimum": 0, "title": "multiple", "type": "number" } }, "required": [ "min", "max" ], "title": "value", "type": "object" } }, "required": [ "id", "type", "operator", "value", "duration_sec" ], "type": "object" }, "title": "reward_modifiers", "type": "array" }, "weight": { "minimum": 0, "title": "weight", "type": "number" } }, "type": "object" }
Apache-2.0
en
heroiclabs/hiro
d3dbe198614ad83f63b21c7b63d83a34682f5762
2023-07-10T10:49:48
schemas/07-Hiro-Inventory.json
16
2024-05-27T08:54:23.844076Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "items": { "patternProperties": { ".{1,}": { "properties": { "category": { "pattern": ".{1,}", "title": "category", "type": "string" }, "consumable": { "title": "consumable", "type": "boolean" }, "consume_reward": { "$ref": "Hiro-Rewards" }, "description": { "pattern": ".{1,}", "title": "description", "type": "string" }, "item_sets": { "items": { "pattern": ".{1,}", "type": "string" }, "title": "item_sets", "type": "array" }, "max_count": { "minimum": 0, "title": "max_count", "type": "number" }, "name": { "pattern": ".{1,}", "title": "name", "type": "string" }, "numeric_properties": { "patternProperties": { ".{1,}": { "type": "number" } }, "title": "string_properties", "type": "object" }, "stackable": { "title": "stackable", "type": "boolean" }, "string_properties": { "patternProperties": { ".{1,}": { "pattern": ".{1,}", "type": "string" } }, "title": "string_properties", "type": "object" } }, "required": [ "name", "category" ], "type": "object" } }, "type": "object" } }, "type": "object" }
Apache-2.0
en
heroiclabs/hiro
d7b50b0be46c97fddf61bde671486233c34f7b69
2023-12-21T15:04:37
schemas/15-Hiro-Stats.json
16
2024-05-27T08:54:23.844076Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "whitelist": { "items": { "type": "string" }, "type": "array" } }, "required": [ "whitelist" ] }
Apache-2.0
en
heroiclabs/hiro
ae6f4be47a00a79a806cea054783e5635d94770c
2024-05-16T22:07:07
schemas/07-Hiro-Inventory.json
16
2024-05-27T08:54:23.844076Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "items": { "patternProperties": { ".{1,}": { "properties": { "category": { "pattern": ".{1,}", "type": "string" }, "consumable": { "type": "boolean" }, "consume_reward": { "$ref": "Hiro-Rewards" }, "description": { "pattern": ".{1,}", "type": "string" }, "item_sets": { "items": { "pattern": ".{1,}", "type": "string" }, "type": "array" }, "max_count": { "minimum": 0, "type": "number" }, "name": { "pattern": ".{1,}", "type": "string" }, "numeric_properties": { "patternProperties": { ".{1,}": { "type": "number" } }, "type": "object" }, "stackable": { "type": "boolean" }, "string_properties": { "patternProperties": { ".{1,}": { "pattern": ".{1,}", "type": "string" } }, "type": "object" } }, "required": [ "name", "category" ], "type": "object" } }, "type": "object" } }, "type": "object" }
Apache-2.0
en
heroiclabs/hiro
2f4efb9704c183fcadf632ae38824bfe3a310cdc
2024-05-17T13:03:18
schemas/13-Hiro-Incentives.json
16
2024-05-27T08:54:23.844076Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "incentives": { "patternProperties": { ".{1,}": { "properties": { "description": { "pattern": ".*", "type": "string" }, "expiry_duration_sec": { "minimum": 0, "type": "integer" }, "max_claims": { "minimum": 0, "type": "integer" }, "max_concurrent": { "minimum": 0, "type": "integer" }, "max_global_claims": { "minimum": 0, "type": "integer" }, "max_recipient_age_sec": { "minimum": 0, "type": "integer" }, "name": { "pattern": ".+", "type": "string" }, "recipient_reward": { "$ref": "Hiro-Rewards" }, "sender_reward": { "$ref": "Hiro-Rewards" }, "type": { "minimum": 0, "type": "integer" } }, "required": [ "type", "name", "max_claims", "max_global_claims", "expiry_duration_sec" ], "type": "object" } }, "type": "object" } }, "required": [ "incentives" ], "type": "object" }
Apache-2.0
en
heroiclabs/hiro
d3dbe198614ad83f63b21c7b63d83a34682f5762
2023-07-10T10:49:48
schemas/04-Hiro-Tutorials.json
16
2024-05-27T08:54:23.844076Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "tutorials": { "patternProperties": { ".{1,}": { "properties": { "additional_properties": { "patternProperties": { ".{1,}": { "title": "key", "type": "string" } }, "title": "additional_properties", "type": "object" }, "max_step": { "minimum": 0, "title": "max_step", "type": "number" }, "start_step": { "minimum": 0, "title": "start_step", "type": "number" } }, "title": "id", "type": "object" } }, "title": "tutorials", "type": "object" } }, "required": [ "tutorials" ], "type": "object" }
Apache-2.0
en
heroiclabs/hiro
d7b50b0be46c97fddf61bde671486233c34f7b69
2023-12-21T15:04:37
schemas/08-Hiro-Energy.json
16
2024-05-27T08:54:23.844076Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "energies": { "patternProperties": { ".{1,}": { "properties": { "additional_properties": { "patternProperties": { ".{1,}": { "title": "key", "type": "string" } }, "title": "additional_properties", "type": "object" }, "implicit": { "title": "implicit", "type": "boolean" }, "max_count": { "minimum": 0, "title": "max_count", "type": "number" }, "max_overfill": { "minimum": 0, "title": "max_overfill", "type": "number" }, "refill_count": { "minimum": 0, "title": "refill_count", "type": "number" }, "refill_time_sec": { "minimum": 0, "title": "refill_time_sec", "type": "number" }, "reward": { "$ref": "Hiro-Rewards" }, "start_count": { "minimum": 0, "title": "start_count", "type": "number" } }, "required": [ "max_count", "refill_count", "refill_time_sec" ], "title": "id", "type": "object" } }, "title": "energies", "type": "object" } }, "required": [ "energies" ], "type": "object" }
Apache-2.0
en
heroiclabs/hiro
c4ee2f5cd52409f28c0efa6f325140139fee7116
2024-05-16T22:07:07
schemas/14-Hiro-Progressions.json
16
2024-05-27T08:54:23.844076Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "definitions": { "ProgressionPreconditionsBlock": { "properties": { "direct": { "properties": { "achievements": { "items": { "type": "string" }, "type": "array" }, "cost": { "properties": { "currencies": { "patternProperties": { ".{1,}": { "type": "integer" } }, "type": "object" }, "items": { "patternProperties": { ".{1,}": { "type": "integer" } }, "type": "object" } }, "type": "object" }, "counts": { "patternProperties": { ".{1,}": { "type": "integer" } }, "type": "object" }, "currency_max": { "patternProperties": { ".{1,}": { "type": "integer" } }, "type": "object" }, "currency_min": { "patternProperties": { ".{1,}": { "type": "integer" } }, "type": "object" }, "energy_max": { "patternProperties": { ".{1,}": { "type": "integer" } }, "type": "object" }, "energy_min": { "patternProperties": { ".{1,}": { "type": "integer" } }, "type": "object" }, "items_max": { "patternProperties": { ".{1,}": { "type": "integer" } }, "type": "object" }, "items_min": { "patternProperties": { ".{1,}": { "type": "integer" } }, "type": "object" }, "progressions": { "items": { "type": "string" }, "type": "array" }, "stats_max": { "patternProperties": { ".{1,}": { "type": "integer" } }, "type": "object" }, "stats_min": { "patternProperties": { ".{1,}": { "type": "integer" } }, "type": "object" } }, "type": "object" }, "nested": { "$ref": "#/definitions/ProgressionPreconditionsBlock" }, "operator": { "minimum": 0, "type": "integer" } }, "type": "object" } }, "properties": { "progressions": { "patternProperties": { ".{1,}": { "properties": { "additional_properties": { "patternProperties": { ".{1,}": { "type": "string" } }, "type": "object" }, "category": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "preconditions": { "$ref": "#/definitions/ProgressionPreconditionsBlock" } }, "required": [], "type": "object" } }, "type": "object" } }, "required": [ "progressions" ], "type": "object" }
Apache-2.0
en
heroiclabs/hiro
ae6f4be47a00a79a806cea054783e5635d94770c
2024-05-16T22:07:07
schemas/13-Hiro-Incentives.json
16
2024-05-27T08:54:23.844076Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "incentives": { "patternProperties": { ".{1,}": { "properties": { "description": { "type": "string" }, "expiry_duration_sec": { "minimum": 0, "type": "integer" }, "max_claims": { "minimum": 0, "type": "integer" }, "max_concurrent": { "minimum": 0, "type": "integer" }, "max_global_claims": { "minimum": 0, "type": "integer" }, "max_recipient_age_sec": { "minimum": 0, "type": "integer" }, "name": { "type": "string" }, "recipient_reward": { "$ref": "Hiro-Rewards" }, "sender_reward": { "$ref": "Hiro-Rewards" }, "type": { "minimum": 0, "type": "integer" } }, "required": [ "type", "name", "max_claims", "max_global_claims", "expiry_duration_sec" ], "type": "object" } }, "type": "object" } }, "required": [ "incentives" ] }
Apache-2.0
en
heroiclabs/hiro
d3dbe198614ad83f63b21c7b63d83a34682f5762
2023-07-10T10:49:48
schemas/11-Hiro-Unlockables.json
16
2024-05-27T08:54:23.844076Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "active_slots": { "minimum": 0, "title": "active_slots", "type": "number" }, "max_active_slots": { "minimum": 0, "title": "max_active_slots", "type": "number" }, "slot_cost": { "properties": { "currencies": { "patternProperties": { ".{1,}": { "minimum": 0, "type": "number" } }, "title": "currencies", "type": "object" }, "items": { "patternProperties": { ".{1,}": { "minimum": 0, "type": "number" } }, "title": "items", "type": "object" } }, "title": "slot_cost", "type": "object" }, "slots": { "minimum": 0, "title": "slots", "type": "number" }, "unlockables": { "patternProperties": { ".{1,}": { "properties": { "additional_properties": { "patternProperties": { ".{1,}": { "title": "key", "type": "string" } }, "title": "additional_properties", "type": "object" }, "category": { "pattern": ".{1,}", "title": "category", "type": "string" }, "cost": { "properties": { "currencies": { "patternProperties": { ".{1,}": { "minimum": 0, "type": "number" } }, "title": "currencies", "type": "object" }, "items": { "patternProperties": { ".{1,}": { "minimum": 0, "type": "number" } }, "title": "items", "type": "object" } }, "title": "cost", "type": "object" }, "cost_unit_time_sec": { "minimum": 0, "title": "cost_unit_time_sec", "type": "number" }, "description": { "pattern": ".{1,}", "title": "description", "type": "string" }, "name": { "pattern": ".{1,}", "title": "name", "type": "string" }, "probability": { "minimum": 0, "title": "probability", "type": "number" }, "reward": { "$ref": "Hiro-Rewards" }, "start_cost": { "properties": { "currencies": { "patternProperties": { ".{1,}": { "minimum": 0, "type": "number" } }, "title": "currencies", "type": "object" }, "items": { "patternProperties": { ".{1,}": { "minimum": 0, "type": "number" } }, "title": "items", "type": "object" } }, "title": "start_cost", "type": "object" }, "wait_time_sec": { "minimum": 0, "title": "wait_time_sec", "type": "number" } }, "required": [ "probability", "category", "name" ], "type": "object" } }, "title": "unlockables", "type": "object" } }, "required": [ "active_slots", "max_active_slots", "slots", "unlockables" ], "type": "object" }
Apache-2.0
en
heroiclabs/hiro
2f4efb9704c183fcadf632ae38824bfe3a310cdc
2024-05-17T13:03:18
schemas/14-Hiro-Progressions.json
16
2024-05-27T08:54:23.844076Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "definitions": { "ProgressionPreconditionsBlock": { "properties": { "direct": { "properties": { "achievements": { "items": { "type": "string" }, "type": "array" }, "cost": { "properties": { "currencies": { "patternProperties": { ".{1,}": { "type": "integer" } }, "type": "object" }, "items": { "patternProperties": { ".{1,}": { "type": "integer" } }, "type": "object" } }, "type": "object" }, "counts": { "patternProperties": { ".{1,}": { "type": "integer" } }, "type": "object" }, "currency_max": { "patternProperties": { ".{1,}": { "type": "integer" } }, "type": "object" }, "currency_min": { "patternProperties": { ".{1,}": { "type": "integer" } }, "type": "object" }, "energy_max": { "patternProperties": { ".{1,}": { "type": "integer" } }, "type": "object" }, "energy_min": { "patternProperties": { ".{1,}": { "type": "integer" } }, "type": "object" }, "items_max": { "patternProperties": { ".{1,}": { "type": "integer" } }, "type": "object" }, "items_min": { "patternProperties": { ".{1,}": { "type": "integer" } }, "type": "object" }, "progressions": { "items": { "type": "string" }, "type": "array" }, "stats_max": { "patternProperties": { ".{1,}": { "type": "integer" } }, "type": "object" }, "stats_min": { "patternProperties": { ".{1,}": { "type": "integer" } }, "type": "object" } }, "type": "object" }, "nested": { "$ref": "#/definitions/ProgressionPreconditionsBlock" }, "operator": { "minimum": 0, "type": "integer" } }, "type": "object" } }, "properties": { "progressions": { "patternProperties": { ".{1,}": { "properties": { "additional_properties": { "patternProperties": { ".{1,}": { "type": "string" } }, "type": "object" }, "category": { "pattern": ".*", "type": "string" }, "description": { "pattern": ".*", "type": "string" }, "name": { "pattern": ".+", "type": "string" }, "preconditions": { "$ref": "#/definitions/ProgressionPreconditionsBlock" } }, "required": [], "type": "object" } }, "type": "object" } }, "required": [ "progressions" ], "type": "object" }
Apache-2.0
en
heroiclabs/hiro
ae6f4be47a00a79a806cea054783e5635d94770c
2024-05-16T22:07:07
schemas/10-Hiro-Achievements.json
16
2024-05-27T08:54:23.844076Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "achievements": { "patternProperties": { ".{1,}": { "properties": { "additional_properties": { "patternProperties": { ".{1,}": { "type": "string" } }, "type": "object" }, "auto_claim": { "type": "boolean" }, "auto_claim_total": { "type": "boolean" }, "auto_reset": { "type": "boolean" }, "category": { "pattern": ".{1,}", "type": "string" }, "count": { "minimum": 0, "type": "number" }, "description": { "pattern": ".{1,}", "type": "string" }, "duration_sec": { "minimum": 0, "type": "number" }, "max_count": { "minimum": 0, "type": "number" }, "name": { "pattern": ".{1,}", "type": "string" }, "precondition_ids": { "items": { "pattern": ".{1,}", "type": "string" }, "type": "array" }, "reset_cronexpr": { "pattern": ".{1,}", "type": "string" }, "reward": { "$ref": "Hiro-Rewards" }, "sub_achievements": { "patternProperties": { ".{1,}": { "properties": { "additional_properties": { "patternProperties": { ".{1,}": { "type": "string" } }, "type": "object" }, "auto_claim": { "type": "boolean" }, "auto_reset": { "type": "boolean" }, "category": { "pattern": ".{1,}", "type": "string" }, "count": { "minimum": 0, "type": "number" }, "description": { "pattern": ".{1,}", "type": "string" }, "duration_sec": { "minimum": 0, "type": "number" }, "max_count": { "minimum": 0, "type": "number" }, "name": { "pattern": ".{1,}", "type": "string" }, "precondition_ids": { "items": { "pattern": ".{1,}", "type": "string" }, "type": "array" }, "reset_cronexpr": { "pattern": ".{1,}", "type": "string" }, "reward": { "$ref": "Hiro-Rewards" } }, "required": [ "name", "category", "max_count" ], "type": "object" } }, "type": "object" }, "total_reward": { "$ref": "Hiro-Rewards" } }, "required": [ "name", "category", "max_count" ], "type": "object" } }, "type": "object" } }, "required": [ "achievements" ], "type": "object" }
Apache-2.0
en
heroiclabs/hiro
ae6f4be47a00a79a806cea054783e5635d94770c
2024-05-16T22:07:07
schemas/03-Hiro-Base.json
16
2024-05-27T08:54:23.844076Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "rate_app_smtp_addr": { "pattern": ".{1,}", "type": "string" }, "rate_app_smtp_email_from": { "format": "email", "type": "string" }, "rate_app_smtp_email_from_name": { "pattern": ".{1,}", "type": "string" }, "rate_app_smtp_email_subject": { "pattern": ".{1,}", "type": "string" }, "rate_app_smtp_email_to": { "format": "email", "type": "string" }, "rate_app_smtp_password": { "pattern": ".{1,}", "type": "string" }, "rate_app_smtp_port": { "maximum": 65535, "minimum": 1, "type": "number" }, "rate_app_smtp_username": { "pattern": ".{1,}", "type": "string" }, "rate_app_template": { "pattern": ".{1,}", "type": "string" } }, "type": "object" }
Apache-2.0
en
heroiclabs/hiro
c4ee2f5cd52409f28c0efa6f325140139fee7116
2024-05-16T22:07:07
schemas/13-Hiro-Incentives.json
16
2024-05-27T08:54:23.844076Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "incentives": { "patternProperties": { ".{1,}": { "properties": { "description": { "type": "string" }, "expiry_duration_sec": { "minimum": 0, "type": "integer" }, "max_claims": { "minimum": 0, "type": "integer" }, "max_concurrent": { "minimum": 0, "type": "integer" }, "max_global_claims": { "minimum": 0, "type": "integer" }, "max_recipient_age_sec": { "minimum": 0, "type": "integer" }, "name": { "type": "string" }, "recipient_reward": { "$ref": "Hiro-Rewards" }, "sender_reward": { "$ref": "Hiro-Rewards" }, "type": { "minimum": 0, "type": "integer" } }, "required": [ "type", "name", "max_claims", "max_global_claims", "expiry_duration_sec" ], "type": "object" } }, "type": "object" } }, "required": [ "incentives" ], "type": "object" }
Apache-2.0
en
up42/up42-py
6263bdafbd09c6e133446a6e59b3ba9b010d0e1e
2023-10-14T10:15:33
tests/mock_data/data_product_spot_schema.json
129
2024-05-28T03:01:24.081537Z
{ "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "allOf": [ { "else": { "definitions": { "projection": { "anyOf": [ { "const": "2154", "title": "2154" }, { "const": "23031", "title": "23031" }, { "const": "25831", "title": "25831" }, { "const": "27563", "title": "27563" }, { "const": "27572", "title": "27572" }, { "const": "27573", "title": "27573" }, { "const": "3035", "title": "3035" }, { "const": "3857", "title": "3857" }, { "const": "4326", "title": "4326" }, { "const": "32631", "title": "32631" } ] } } }, "if": { "properties": { "geometricProcessing": { "const": "primary" } } }, "then": { "definitions": { "projection": { "const": null } } } }, { "allOf": [ { "if": { "properties": { "acquisitionMode": { "const": "mono" } } }, "then": { "definitions": { "maxBH": { "const": null }, "minBH": { "const": null } } } }, { "if": { "properties": { "acquisitionMode": { "const": "stereo" } } }, "then": { "definitions": { "maxBH": { "default": 0.7, "maximum": 0.8, "minimum": 0.2, "type": "number" }, "minBH": { "default": 0.4, "maximum": 0.8, "minimum": 0.2, "type": "number" } } } }, { "if": { "properties": { "acquisitionMode": { "const": "tristereo" } } }, "then": { "definitions": { "maxBH": { "default": 0.35, "maximum": 0.8, "minimum": 0.2, "type": "number" }, "minBH": { "default": 0.2, "maximum": 0.8, "minimum": 0.2, "type": "number" } } } } ] }, { "else": { "definitions": { "radiometricProcessing": { "anyOf": [ { "const": "basic", "title": "Basic" }, { "const": "display", "title": "Display" }, { "const": "reflectance", "title": "Reflectance" } ] } } }, "if": { "properties": { "pixelCoding": { "const": "8bits" } } }, "then": { "definitions": { "radiometricProcessing": { "anyOf": [ { "const": "basic", "title": "Basic" }, { "const": "display", "title": "Display" } ] } } } } ], "definitions": { "Polygon": { "description": "Polygon Model.", "properties": { "coordinates": { "items": { "items": { "items": { "type": "number" }, "maxItems": 2, "minItems": 2, "type": "array" }, "minItems": 4, "type": "array" }, "type": "array" }, "type": { "const": "Polygon", "default": "Polygon", "title": "Type", "type": "string" } }, "required": [ "coordinates" ], "title": "Polygon", "type": "object" }, "acquisitionMode": { "anyOf": [ { "const": "mono", "title": "MONO" }, { "const": "stereo", "title": "STEREO" }, { "const": "tristereo", "title": "TRISTEREO" } ], "default": null, "title": "acquisitionMode" }, "deliveredAs": { "anyOf": [ { "const": "geotiff", "title": "DIMAP-GeoTIFF" } ], "default": "geotiff", "title": "deliveredAs" }, "geometricProcessing": { "anyOf": [ { "const": "ortho", "title": "Ortho" } ], "default": "ortho", "title": "geometricProcessing" }, "pixelCoding": { "anyOf": [ { "const": "12bits", "title": "12 bits (JPEG 2000) / 16 bits (GeoTIFF)" } ], "default": "12bits", "title": "pixelCoding" }, "projection": { "anyOf": [ { "const": "4326", "title": "4326" } ], "default": "4326", "title": "projection" }, "radiometricProcessing": { "anyOf": [ { "const": "reflectance", "title": "Reflectance" } ], "default": "reflectance", "title": "radiometricProcessing" }, "spectralProcessing": { "anyOf": [ { "const": "bundle", "title": "Bundle: Panchromatic + Multispectral 4-band" } ], "default": "bundle", "title": "spectralProcessing" } }, "properties": { "acquisitionEnd": { "format": "date-time", "title": "End", "type": "string" }, "acquisitionMode": { "allOf": [ { "$ref": "#/definitions/acquisitionMode" } ], "description": "Acquisition can be set to be monoscopic (imaging from one viewpoint on the same orbit) or stereoscopic (imaging from at least two viewpoints on the same orbit). Stereo imaging is ideal for creating 3D models and tristereo introduces an additional acquisition at nadir which minimises the risk of missing hidden items.", "title": "Acquisition mode", "type": "string" }, "acquisitionStart": { "format": "date-time", "title": "Start", "type": "string" }, "cloudCoverage": { "description": "Maximum allowed cloud coverage in percentage.", "maximum": 20, "minimum": 5, "title": "Maximum cloud coverage (%)", "type": "integer" }, "deliveredAs": { "allOf": [ { "$ref": "#/definitions/deliveredAs" } ], "description": "The GeoTIFF format is free of any compression. JPEG 2000 Optimised is intended for those looking for fast download and easy data sharing. JPEG 2000 Regular is perfect for users who plan to do high precision post-processing.", "title": "Delivery format", "type": "string" }, "displayName": { "title": "Order name", "type": "string" }, "extraDescription": { "title": "Description", "type": "string" }, "geometricProcessing": { "allOf": [ { "$ref": "#/definitions/geometricProcessing" } ], "description": "The Primary product is the geometric processing level closest to the natural image acquired by the sensor. The Projected level results from an additional process to map the image onto an Earth cartographic system. The Ortho product is a georeferenced image in Earth geometry, corrected from acquisition and terrain off-nadir effects.", "title": "Geometric processing", "type": "string" }, "geometry": { "allOf": [ { "$ref": "#/definitions/Polygon" } ], "title": "Geometry", "type": "object" }, "incidenceAngle": { "description": "Maximum allowed incidence angle in degree.", "maximum": 50, "minimum": 5, "title": "Maximum incidence angle (\u00b0)", "type": "integer" }, "maxBH": { "description": "For stereoscopic and tri-stereoscopic imaging, the angular difference (B/H) can be adjusted. If no maximum angle is specified, 0.7 is set as the default value for stereo and 0.35 for tristereo.", "maximum": 0.8, "minimum": 0.2, "title": "Maximum B/H ratio", "type": "number" }, "minBH": { "description": "For stereoscopic and tri-stereoscopic imaging, the angular difference (B/H) can be adjusted. If no minimum angle is specified, 0.4 is set as the default value for stereo and 0.2 for tristereo.", "maximum": 0.8, "minimum": 0.2, "title": "Minimum B/H ratio", "type": "number" }, "pixelCoding": { "allOf": [ { "$ref": "#/definitions/pixelCoding" } ], "description": "8-bit product encoding is supported for basic and display radiometric processing while 12-bit/16-bit product encoding is supported for basic, display and reflectance radiometric processing.", "title": "Bit depth per pixel", "type": "string" }, "projection": { "allOf": [ { "$ref": "#/definitions/projection" } ], "description": "For projected and ortho level products, the selected projection reference system is used for the processing and georeferencing.", "title": "Coordinate reference system", "type": "string" }, "radiometricProcessing": { "allOf": [ { "$ref": "#/definitions/radiometricProcessing" } ], "description": "Basic imagery corresponds to raw data without any radiometric processing. Ideal to carry up own calibration and own spectral analysis. Reflectance imagery is radiometrically corrected from sensor calibration and systematic atmospheric effects. In the Display radiometric option, a true colour curve has been applied to the image directly usable for visualisation on screen.", "title": "Radiometric processing", "type": "string" }, "spectralProcessing": { "allOf": [ { "$ref": "#/definitions/spectralProcessing" } ], "description": "The Pl\u00e9iades Panchromatic product includes only one black and white band.The Multispectral product includes four Multispectral (color) bands: Blue, Red, Green and Near Infrared. The Panchromatic and Multispectral products, simultaneously acquired, are packaged together separately (not merged) for a single delivery (1 file for Multispectral + 1 file for Panchromatic).", "title": "Spectral bands combination", "type": "string" } }, "required": [ "geometry", "displayName", "acquisitionStart", "acquisitionEnd", "acquisitionMode", "cloudCoverage", "incidenceAngle", "geometricProcessing", "spectralProcessing", "pixelCoding", "radiometricProcessing", "deliveredAs" ], "type": "object" }
MIT
en
up42/up42-py
6263bdafbd09c6e133446a6e59b3ba9b010d0e1e
2023-10-14T10:15:33
tests/mock_data/data_product_schema_phr_tasking.json
129
2024-05-28T03:01:24.081537Z
{ "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "allOf": [ { "else": { "definitions": { "projection": { "anyOf": [ { "const": "2154", "title": "2154" }, { "const": "23031", "title": "23031" }, { "const": "25831", "title": "25831" }, { "const": "27563", "title": "27563" }, { "const": "27572", "title": "27572" }, { "const": "27573", "title": "27573" }, { "const": "3035", "title": "3035" }, { "const": "3857", "title": "3857" }, { "const": "4326", "title": "4326" }, { "const": "32631", "title": "32631" } ] } } }, "if": { "properties": { "geometricProcessing": { "const": "primary" } } }, "then": { "definitions": { "projection": { "const": null } } } }, { "allOf": [ { "if": { "properties": { "acquisitionMode": { "const": "mono" } } }, "then": { "definitions": { "maxBH": { "const": null }, "minBH": { "const": null } } } }, { "if": { "properties": { "acquisitionMode": { "const": "stereo" } } }, "then": { "definitions": { "maxBH": { "default": 0.7, "maximum": 0.8, "minimum": 0.2, "type": "number" }, "minBH": { "default": 0.4, "maximum": 0.8, "minimum": 0.2, "type": "number" } } } }, { "if": { "properties": { "acquisitionMode": { "const": "tristereo" } } }, "then": { "definitions": { "maxBH": { "default": 0.35, "maximum": 0.8, "minimum": 0.2, "type": "number" }, "minBH": { "default": 0.2, "maximum": 0.8, "minimum": 0.2, "type": "number" } } } } ] }, { "else": { "definitions": { "radiometricProcessing": { "anyOf": [ { "const": "basic", "title": "Basic" }, { "const": "display", "title": "Display" }, { "const": "reflectance", "title": "Reflectance" } ] } } }, "if": { "properties": { "pixelCoding": { "const": "8bits" } } }, "then": { "definitions": { "radiometricProcessing": { "anyOf": [ { "const": "basic", "title": "Basic" }, { "const": "display", "title": "Display" } ] } } } } ], "definitions": { "Polygon": { "description": "Polygon Model.", "properties": { "coordinates": { "items": { "items": { "items": { "type": "number" }, "maxItems": 2, "minItems": 2, "type": "array" }, "minItems": 4, "type": "array" }, "type": "array" }, "type": { "const": "Polygon", "default": "Polygon", "title": "Type", "type": "string" } }, "required": [ "coordinates" ], "title": "Polygon", "type": "object" }, "acquisitionMode": { "anyOf": [ { "const": "mono", "title": "MONO" }, { "const": "stereo", "title": "STEREO" }, { "const": "tristereo", "title": "TRISTEREO" } ], "default": null, "title": "acquisitionMode" }, "deliveredAs": { "anyOf": [ { "const": "geotiff", "title": "DIMAP-GeoTIFF" } ], "default": "geotiff", "title": "deliveredAs" }, "geometricProcessing": { "anyOf": [ { "const": "ortho", "title": "Ortho" } ], "default": "ortho", "title": "geometricProcessing" }, "pixelCoding": { "anyOf": [ { "const": "12bits", "title": "12 bits (JPEG 2000) / 16 bits (GeoTIFF)" } ], "default": "12bits", "title": "pixelCoding" }, "projection": { "anyOf": [ { "const": "4326", "title": "4326" } ], "default": "4326", "title": "projection" }, "radiometricProcessing": { "anyOf": [ { "const": "reflectance", "title": "Reflectance" } ], "default": "reflectance", "title": "radiometricProcessing" }, "spectralProcessing": { "anyOf": [ { "const": "bundle", "title": "Bundle: Panchromatic + Multispectral 4-band" } ], "default": "bundle", "title": "spectralProcessing" } }, "properties": { "acquisitionEnd": { "format": "date-time", "title": "End", "type": "string" }, "acquisitionMode": { "allOf": [ { "$ref": "#/definitions/acquisitionMode" } ], "description": "Acquisition can be set to be monoscopic (imaging from one viewpoint on the same orbit) or stereoscopic (imaging from at least two viewpoints on the same orbit). Stereo imaging is ideal for creating 3D models and tristereo introduces an additional acquisition at nadir which minimises the risk of missing hidden items.", "title": "Acquisition mode", "type": "string" }, "acquisitionStart": { "format": "date-time", "title": "Start", "type": "string" }, "cloudCoverage": { "description": "Maximum allowed cloud coverage in percentage.", "maximum": 20, "minimum": 5, "title": "Maximum cloud coverage (%)", "type": "integer" }, "deliveredAs": { "allOf": [ { "$ref": "#/definitions/deliveredAs" } ], "description": "The GeoTIFF format is free of any compression. JPEG 2000 Optimised is intended for those looking for fast download and easy data sharing. JPEG 2000 Regular is perfect for users who plan to do high precision post-processing.", "title": "Delivery format", "type": "string" }, "displayName": { "title": "Order name", "type": "string" }, "extraDescription": { "title": "Description", "type": "string" }, "geometricProcessing": { "allOf": [ { "$ref": "#/definitions/geometricProcessing" } ], "description": "The Primary product is the geometric processing level closest to the natural image acquired by the sensor. The Projected level results from an additional process to map the image onto an Earth cartographic system. The Ortho product is a georeferenced image in Earth geometry, corrected from acquisition and terrain off-nadir effects.", "title": "Geometric processing", "type": "string" }, "geometry": { "allOf": [ { "$ref": "#/definitions/Polygon" } ], "title": "Geometry", "type": "object" }, "incidenceAngle": { "description": "Maximum allowed incidence angle in degree.", "maximum": 50, "minimum": 5, "title": "Maximum incidence angle (\u00b0)", "type": "integer" }, "maxBH": { "description": "For stereoscopic and tri-stereoscopic imaging, the angular difference (B/H) can be adjusted. If no maximum angle is specified, 0.7 is set as the default value for stereo and 0.35 for tristereo.", "maximum": 0.8, "minimum": 0.2, "title": "Maximum B/H ratio", "type": "number" }, "minBH": { "description": "For stereoscopic and tri-stereoscopic imaging, the angular difference (B/H) can be adjusted. If no minimum angle is specified, 0.4 is set as the default value for stereo and 0.2 for tristereo.", "maximum": 0.8, "minimum": 0.2, "title": "Minimum B/H ratio", "type": "number" }, "pixelCoding": { "allOf": [ { "$ref": "#/definitions/pixelCoding" } ], "description": "8-bit product encoding is supported for basic and display radiometric processing while 12-bit/16-bit product encoding is supported for basic, display and reflectance radiometric processing.", "title": "Bit depth per pixel", "type": "string" }, "projection": { "allOf": [ { "$ref": "#/definitions/projection" } ], "description": "For projected and ortho level products, the selected projection reference system is used for the processing and georeferencing.", "title": "Coordinate reference system", "type": "string" }, "radiometricProcessing": { "allOf": [ { "$ref": "#/definitions/radiometricProcessing" } ], "description": "Basic imagery corresponds to raw data without any radiometric processing. Ideal to carry up own calibration and own spectral analysis. Reflectance imagery is radiometrically corrected from sensor calibration and systematic atmospheric effects. In the Display radiometric option, a true colour curve has been applied to the image directly usable for visualisation on screen.", "title": "Radiometric processing", "type": "string" }, "spectralProcessing": { "allOf": [ { "$ref": "#/definitions/spectralProcessing" } ], "description": "The Pl\u00e9iades Panchromatic product includes only one black and white band.The Multispectral product includes four Multispectral (color) bands: Blue, Red, Green and Near Infrared. The Panchromatic and Multispectral products, simultaneously acquired, are packaged together separately (not merged) for a single delivery (1 file for Multispectral + 1 file for Panchromatic).", "title": "Spectral bands combination", "type": "string" } }, "required": [ "geometry", "displayName", "acquisitionStart", "acquisitionEnd", "acquisitionMode", "cloudCoverage", "incidenceAngle", "geometricProcessing", "spectralProcessing", "pixelCoding", "radiometricProcessing", "deliveredAs" ], "type": "object" }
MIT
en
up42/up42-py
dbc63b2df26c8a6e4ae536847134948f498ec700
2023-07-14T12:12:50
tests/mock_data/data_product_spot_schema.json
129
2024-05-28T03:01:24.081537Z
{ "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "allOf": [ { "else": { "definitions": { "projection": { "anyOf": [ { "const": "2154", "title": "2154" }, { "const": "23031", "title": "23031" }, { "const": "25831", "title": "25831" }, { "const": "27563", "title": "27563" }, { "const": "27572", "title": "27572" }, { "const": "27573", "title": "27573" }, { "const": "3035", "title": "3035" }, { "const": "3857", "title": "3857" }, { "const": "4326", "title": "4326" }, { "const": "32631", "title": "32631" } ] } } }, "if": { "properties": { "geometricProcessing": { "const": "primary" } } }, "then": { "definitions": { "projection": { "const": null } } } }, { "allOf": [ { "if": { "properties": { "acquisitionMode": { "const": "mono" } } }, "then": { "definitions": { "maxBH": { "const": null }, "minBH": { "const": null } } } }, { "if": { "properties": { "acquisitionMode": { "const": "stereo" } } }, "then": { "definitions": { "maxBH": { "default": 0.7, "maximum": 0.8, "minimum": 0.2, "type": "number" }, "minBH": { "default": 0.4, "maximum": 0.8, "minimum": 0.2, "type": "number" } } } }, { "if": { "properties": { "acquisitionMode": { "const": "tristereo" } } }, "then": { "definitions": { "maxBH": { "default": 0.35, "maximum": 0.8, "minimum": 0.2, "type": "number" }, "minBH": { "default": 0.2, "maximum": 0.8, "minimum": 0.2, "type": "number" } } } } ] }, { "else": { "definitions": { "radiometricProcessing": { "anyOf": [ { "const": "basic", "title": "Basic" }, { "const": "display", "title": "Display" }, { "const": "reflectance", "title": "Reflectance" } ] } } }, "if": { "properties": { "pixelCoding": { "const": "8bits" } } }, "then": { "definitions": { "radiometricProcessing": { "anyOf": [ { "const": "basic", "title": "Basic" }, { "const": "display", "title": "Display" } ] } } } } ], "definitions": { "Polygon": { "description": "Polygon Model.", "properties": { "coordinates": { "items": { "items": { "items": { "type": "number" }, "maxItems": 2, "minItems": 2, "type": "array" }, "minItems": 4, "type": "array" }, "type": "array" }, "type": { "const": "Polygon", "default": "Polygon", "title": "Type", "type": "string" } }, "required": [ "coordinates" ], "title": "Polygon", "type": "object" }, "acquisitionMode": { "anyOf": [ { "const": "mono", "title": "MONO" }, { "const": "stereo", "title": "STEREO" }, { "const": "tristereo", "title": "TRISTEREO" } ], "default": null, "title": "acquisitionMode" }, "deliveredAs": { "anyOf": [ { "const": "geotiff", "title": "DIMAP-GeoTIFF" } ], "default": "geotiff", "title": "deliveredAs" }, "geometricProcessing": { "anyOf": [ { "const": "ortho", "title": "Ortho" } ], "default": "ortho", "title": "geometricProcessing" }, "pixelCoding": { "anyOf": [ { "const": "12bits", "title": "12 bits (JPEG 2000) / 16 bits (GeoTIFF)" } ], "default": "12bits", "title": "pixelCoding" }, "projection": { "anyOf": [ { "const": "4326", "title": "4326" } ], "default": "4326", "title": "projection" }, "radiometricProcessing": { "anyOf": [ { "const": "reflectance", "title": "Reflectance" } ], "default": "reflectance", "title": "radiometricProcessing" }, "spectralProcessing": { "anyOf": [ { "const": "bundle", "title": "Bundle: Panchromatic + Multispectral 4-band" } ], "default": "bundle", "title": "spectralProcessing" } }, "properties": { "acquisitionEnd": { "format": "date-time", "title": "End", "type": "string" }, "acquisitionMode": { "allOf": [ { "$ref": "#/definitions/acquisitionMode" } ], "description": "Acquisition can be set to be monoscopic (imaging from one viewpoint on the same orbit) or stereoscopic (imaging from at least two viewpoints on the same orbit). Stereo imaging is ideal for creating 3D models and tristereo introduces an additional acquisition at nadir which minimises the risk of missing hidden items.", "title": "Acquisition mode", "type": "string" }, "acquisitionStart": { "format": "date-time", "title": "Start", "type": "string" }, "cloudCoverage": { "description": "Maximum allowed cloud coverage in percentage.", "maximum": 20, "minimum": 5, "title": "Maximum cloud coverage (%)", "type": "integer" }, "deliveredAs": { "allOf": [ { "$ref": "#/definitions/deliveredAs" } ], "description": "The GeoTIFF format is free of any compression. JPEG 2000 Optimised is intended for those looking for fast download and easy data sharing. JPEG 2000 Regular is perfect for users who plan to do high precision post-processing.", "title": "Delivery format", "type": "string" }, "displayName": { "title": "Order name", "type": "string" }, "extraDescription": { "title": "Description", "type": "string" }, "geometricProcessing": { "allOf": [ { "$ref": "#/definitions/geometricProcessing" } ], "description": "The Primary product is the geometric processing level closest to the natural image acquired by the sensor. The Projected level results from an additional process to map the image onto an Earth cartographic system. The Ortho product is a georeferenced image in Earth geometry, corrected from acquisition and terrain off-nadir effects.", "title": "Geometric processing", "type": "string" }, "geometry": { "allOf": [ { "$ref": "#/definitions/Polygon" } ], "title": "Geometry", "type": "object" }, "incidenceAngle": { "description": "Maximum allowed incidence angle in degree.", "maximum": 50, "minimum": 5, "title": "Maximum incidence angle (\u00b0)", "type": "integer" }, "maxBH": { "description": "For stereoscopic and tri-stereoscopic imaging, the angular difference (B/H) can be adjusted. If no maximum angle is specified, 0.7 is set as the default value for stereo and 0.35 for tristereo.", "maximum": 0.8, "minimum": 0.2, "title": "Maximum B/H ratio", "type": "number" }, "minBH": { "description": "For stereoscopic and tri-stereoscopic imaging, the angular difference (B/H) can be adjusted. If no minimum angle is specified, 0.4 is set as the default value for stereo and 0.2 for tristereo.", "maximum": 0.8, "minimum": 0.2, "title": "Minimum B/H ratio", "type": "number" }, "pixelCoding": { "allOf": [ { "$ref": "#/definitions/pixelCoding" } ], "description": "8-bit product encoding is supported for basic and display radiometric processing while 12-bit/16-bit product encoding is supported for basic, display and reflectance radiometric processing.", "title": "Bit depth per pixel", "type": "string" }, "projection": { "allOf": [ { "$ref": "#/definitions/projection" } ], "description": "For projected and ortho level products, the selected projection reference system is used for the processing and georeferencing.", "title": "Coordinate reference system", "type": "string" }, "radiometricProcessing": { "allOf": [ { "$ref": "#/definitions/radiometricProcessing" } ], "description": "Basic imagery corresponds to raw data without any radiometric processing. Ideal to carry up own calibration and own spectral analysis. Reflectance imagery is radiometrically corrected from sensor calibration and systematic atmospheric effects. In the Display radiometric option, a true colour curve has been applied to the image directly usable for visualisation on screen.", "title": "Radiometric processing", "type": "string" }, "spectralProcessing": { "allOf": [ { "$ref": "#/definitions/spectralProcessing" } ], "description": "The Pl\u00e9iades Panchromatic product includes only one black and white band.The Multispectral product includes four Multispectral (color) bands: Blue, Red, Green and Near Infrared. The Panchromatic and Multispectral products, simultaneously acquired, are packaged together separately (not merged) for a single delivery (1 file for Multispectral + 1 file for Panchromatic).", "title": "Spectral bands combination", "type": "string" } }, "required": [ "geometry", "displayName", "acquisitionStart", "acquisitionEnd", "acquisitionMode", "cloudCoverage", "incidenceAngle", "geometricProcessing", "spectralProcessing", "pixelCoding", "radiometricProcessing", "deliveredAs" ], "type": "object" }
MIT
en
up42/up42-py
dbc63b2df26c8a6e4ae536847134948f498ec700
2023-07-14T12:12:50
tests/mock_data/data_product_schema_phr_tasking.json
129
2024-05-28T03:01:24.081537Z
{ "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "allOf": [ { "else": { "definitions": { "projection": { "anyOf": [ { "const": "2154", "title": "2154" }, { "const": "23031", "title": "23031" }, { "const": "25831", "title": "25831" }, { "const": "27563", "title": "27563" }, { "const": "27572", "title": "27572" }, { "const": "27573", "title": "27573" }, { "const": "3035", "title": "3035" }, { "const": "3857", "title": "3857" }, { "const": "4326", "title": "4326" }, { "const": "32631", "title": "32631" } ] } } }, "if": { "properties": { "geometricProcessing": { "const": "primary" } } }, "then": { "definitions": { "projection": { "const": null } } } }, { "allOf": [ { "if": { "properties": { "acquisitionMode": { "const": "mono" } } }, "then": { "definitions": { "maxBH": { "const": null }, "minBH": { "const": null } } } }, { "if": { "properties": { "acquisitionMode": { "const": "stereo" } } }, "then": { "definitions": { "maxBH": { "default": 0.7, "maximum": 0.8, "minimum": 0.2, "type": "number" }, "minBH": { "default": 0.4, "maximum": 0.8, "minimum": 0.2, "type": "number" } } } }, { "if": { "properties": { "acquisitionMode": { "const": "tristereo" } } }, "then": { "definitions": { "maxBH": { "default": 0.35, "maximum": 0.8, "minimum": 0.2, "type": "number" }, "minBH": { "default": 0.2, "maximum": 0.8, "minimum": 0.2, "type": "number" } } } } ] }, { "else": { "definitions": { "radiometricProcessing": { "anyOf": [ { "const": "basic", "title": "Basic" }, { "const": "display", "title": "Display" }, { "const": "reflectance", "title": "Reflectance" } ] } } }, "if": { "properties": { "pixelCoding": { "const": "8bits" } } }, "then": { "definitions": { "radiometricProcessing": { "anyOf": [ { "const": "basic", "title": "Basic" }, { "const": "display", "title": "Display" } ] } } } } ], "definitions": { "Polygon": { "description": "Polygon Model.", "properties": { "coordinates": { "items": { "items": { "items": { "type": "number" }, "maxItems": 2, "minItems": 2, "type": "array" }, "minItems": 4, "type": "array" }, "type": "array" }, "type": { "const": "Polygon", "default": "Polygon", "title": "Type", "type": "string" } }, "required": [ "coordinates" ], "title": "Polygon", "type": "object" }, "acquisitionMode": { "anyOf": [ { "const": "mono", "title": "MONO" }, { "const": "stereo", "title": "STEREO" }, { "const": "tristereo", "title": "TRISTEREO" } ], "default": null, "title": "acquisitionMode" }, "deliveredAs": { "anyOf": [ { "const": "geotiff", "title": "DIMAP-GeoTIFF" } ], "default": "geotiff", "title": "deliveredAs" }, "geometricProcessing": { "anyOf": [ { "const": "ortho", "title": "Ortho" } ], "default": "ortho", "title": "geometricProcessing" }, "pixelCoding": { "anyOf": [ { "const": "12bits", "title": "12 bits (JPEG 2000) / 16 bits (GeoTIFF)" } ], "default": "12bits", "title": "pixelCoding" }, "projection": { "anyOf": [ { "const": "4326", "title": "4326" } ], "default": "4326", "title": "projection" }, "radiometricProcessing": { "anyOf": [ { "const": "reflectance", "title": "Reflectance" } ], "default": "reflectance", "title": "radiometricProcessing" }, "spectralProcessing": { "anyOf": [ { "const": "bundle", "title": "Bundle: Panchromatic + Multispectral 4-band" } ], "default": "bundle", "title": "spectralProcessing" } }, "properties": { "acquisitionEnd": { "format": "date-time", "title": "End", "type": "string" }, "acquisitionMode": { "allOf": [ { "$ref": "#/definitions/acquisitionMode" } ], "description": "Acquisition can be set to be monoscopic (imaging from one viewpoint on the same orbit) or stereoscopic (imaging from at least two viewpoints on the same orbit). Stereo imaging is ideal for creating 3D models and tristereo introduces an additional acquisition at nadir which minimises the risk of missing hidden items.", "title": "Acquisition mode", "type": "string" }, "acquisitionStart": { "format": "date-time", "title": "Start", "type": "string" }, "cloudCoverage": { "description": "Maximum allowed cloud coverage in percentage.", "maximum": 20, "minimum": 5, "title": "Maximum cloud coverage (%)", "type": "integer" }, "deliveredAs": { "allOf": [ { "$ref": "#/definitions/deliveredAs" } ], "description": "The GeoTIFF format is free of any compression. JPEG 2000 Optimised is intended for those looking for fast download and easy data sharing. JPEG 2000 Regular is perfect for users who plan to do high precision post-processing.", "title": "Delivery format", "type": "string" }, "displayName": { "title": "Order name", "type": "string" }, "extraDescription": { "title": "Description", "type": "string" }, "geometricProcessing": { "allOf": [ { "$ref": "#/definitions/geometricProcessing" } ], "description": "The Primary product is the geometric processing level closest to the natural image acquired by the sensor. The Projected level results from an additional process to map the image onto an Earth cartographic system. The Ortho product is a georeferenced image in Earth geometry, corrected from acquisition and terrain off-nadir effects.", "title": "Geometric processing", "type": "string" }, "geometry": { "allOf": [ { "$ref": "#/definitions/Polygon" } ], "title": "Geometry", "type": "object" }, "incidenceAngle": { "description": "Maximum allowed incidence angle in degree.", "maximum": 50, "minimum": 5, "title": "Maximum incidence angle (\u00b0)", "type": "integer" }, "maxBH": { "description": "For stereoscopic and tri-stereoscopic imaging, the angular difference (B/H) can be adjusted. If no maximum angle is specified, 0.7 is set as the default value for stereo and 0.35 for tristereo.", "maximum": 0.8, "minimum": 0.2, "title": "Maximum B/H ratio", "type": "number" }, "minBH": { "description": "For stereoscopic and tri-stereoscopic imaging, the angular difference (B/H) can be adjusted. If no minimum angle is specified, 0.4 is set as the default value for stereo and 0.2 for tristereo.", "maximum": 0.8, "minimum": 0.2, "title": "Minimum B/H ratio", "type": "number" }, "pixelCoding": { "allOf": [ { "$ref": "#/definitions/pixelCoding" } ], "description": "8-bit product encoding is supported for basic and display radiometric processing while 12-bit/16-bit product encoding is supported for basic, display and reflectance radiometric processing.", "title": "Bit depth per pixel", "type": "string" }, "projection": { "allOf": [ { "$ref": "#/definitions/projection" } ], "description": "For projected and ortho level products, the selected projection reference system is used for the processing and georeferencing.", "title": "Coordinate reference system", "type": "string" }, "radiometricProcessing": { "allOf": [ { "$ref": "#/definitions/radiometricProcessing" } ], "description": "Basic imagery corresponds to raw data without any radiometric processing. Ideal to carry up own calibration and own spectral analysis. Reflectance imagery is radiometrically corrected from sensor calibration and systematic atmospheric effects. In the Display radiometric option, a true colour curve has been applied to the image directly usable for visualisation on screen.", "title": "Radiometric processing", "type": "string" }, "spectralProcessing": { "allOf": [ { "$ref": "#/definitions/spectralProcessing" } ], "description": "The Pl\u00e9iades Panchromatic product includes only one black and white band.The Multispectral product includes four Multispectral (color) bands: Blue, Red, Green and Near Infrared. The Panchromatic and Multispectral products, simultaneously acquired, are packaged together separately (not merged) for a single delivery (1 file for Multispectral + 1 file for Panchromatic).", "title": "Spectral bands combination", "type": "string" } }, "required": [ "geometry", "displayName", "acquisitionStart", "acquisitionEnd", "acquisitionMode", "cloudCoverage", "incidenceAngle", "geometricProcessing", "spectralProcessing", "pixelCoding", "radiometricProcessing", "deliveredAs" ], "type": "object" }
MIT
en
AMNatty/plutoengine
d9a583ed8bfaad84f907bd730e8166c0adc10270
2022-04-06T09:04:32
engine-demo/basic-application/mods/tefek.demo.basicapplication/info.schema.json
6
2024-05-28T06:07:24.499829Z
{ "$defs": { "nonEmptyString": { "pattern": "^.+$", "type": "string" }, "virtualAddress": { "$ref": "#/$defs/nonEmptyString", "pattern": "^([a-zA-Z0-9_-]+\\.)*[a-zA-Z0-9_-]+$" } }, "$id": "https://plutoengine.org/developer/mod.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "author": { "$ref": "#/$defs/nonEmptyString", "description": "Name(s) of the author(s) of this mod." }, "description": { "description": "Short description string.", "type": "string" }, "displayName": { "$ref": "#/$defs/nonEmptyString", "description": "This name will be visible in applications when browsing the mod list. It does not necessarily need to be unique, however should be representative of the mod." }, "resourceRoots": { "additionalProperties": { "properties": { "path": { "type": "string" }, "type": { "enum": [ "open", "zip" ] } }, "required": [ "type", "path" ], "type": "object" }, "properties": {}, "propertyNames": { "$ref": "#/$defs/virtualAddress" }, "type": "object" } }, "required": [ "displayName", "author", "resourceRoots" ], "title": "PlutoEngine mod schema", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
a6639d72115e88c9141b3fbfb1b56aa69ff76109
2024-04-16T01:55:21
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default", "bright_black", "bright_red", "bright_green", "bright_yellow", "bright_blue", "bright_magenta", "bright_cyan", "bright_white" ], "type": "string" }, "format": { "description": "Output format of the module", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "osFile": { "description": "Set the path to the file containing OS information. Linux only", "type": "string" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "break", "brightness", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "anyOf": [ { "const": "bios", "description": "Print BIOS name, version, release date, etc" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "required": [ "format" ], "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "forceVulkan": { "default": false, "description": "Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": "winget", "description": "A colon separated list of package managers to be disabled when detecting", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
28805365135f59120fc969ceba034f9fd60935fd
2024-05-08T07:01:57
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default", "bright_black", "bright_red", "bright_green", "bright_yellow", "bright_blue", "bright_magenta", "bright_cyan", "bright_white" ], "type": "string" }, "format": { "description": "Output format of the module", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/colors", "description": "Output color of the module" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "output": { "$ref": "#/$defs/colors", "description": "Set the color of the module output" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" }, "tsVersion": { "default": true, "description": "Whether to detect and display the version of terminal and shell. Mainly for benchmarking", "type": "boolean" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "break", "brightness", "camera", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "anyOf": [ { "const": "bios", "description": "Print BIOS name, version, release date, etc" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "camera", "description": "Print available cameras" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "key": { "$ref": "#/$defs/key" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points\nThis option overrides other `show*` options", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "forceVulkan": { "default": false, "description": "Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": [ "winget" ], "description": "List of package managers to be disabled when detecting", "items": { "enum": [ "am", "apk", "brew", "choco", "dpkg", "emerge", "eopkg", "flatpak", "macports", "nix", "opkg", "pacman", "paludis", "pkg", "pkgtool", "rpm", "scoop", "snap", "winget", "xbps" ], "type": "string", "uniqueItems": true }, "type": "array" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
5147651bcbca9efd8198a1a802f1024d10e8fffd
2024-02-27T05:11:39
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default", "bright_black", "bright_red", "bright_green", "bright_yellow", "bright_blue", "bright_magenta", "bright_cyan", "bright_white" ], "type": "string" }, "format": { "description": "Output format of the module", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "percent": { "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "description": "Set how a percentage value should be displayed", "properties": { "color": { "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "description": "Set how temperature values should be displayed", "properties": { "color": { "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "osFile": { "description": "Set the path to the file containing OS information. Linux only", "type": "string" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "break", "brightness", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "anyOf": [ { "const": "bios", "description": "Print BIOS name, version, release date, etc" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } } }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth" }, { "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness" }, { "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU" }, { "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage" }, { "properties": { "block": { "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "required": [ "format" ], "title": "Custom" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO" }, { "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad" }, { "additionalProperties": false, "properties": { "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "forceVulkan": { "default": false, "description": "Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL" }, { "properties": { "disabled": { "default": "winget", "description": "A colon separated list of package managers to be disabled when detecting", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP" }, { "additionalProperties": false, "properties": { "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } } }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather" }, { "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
e63dfdd8b13f7a4ce386cca93a9556d74cbb1a16
2024-04-16T02:16:31
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default", "bright_black", "bright_red", "bright_green", "bright_yellow", "bright_blue", "bright_magenta", "bright_cyan", "bright_white" ], "type": "string" }, "format": { "description": "Output format of the module", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "osFile": { "description": "Set the path to the file containing OS information. Linux only", "type": "string" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "break", "brightness", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "anyOf": [ { "const": "bios", "description": "Print BIOS name, version, release date, etc" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "required": [ "format" ], "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "forceVulkan": { "default": false, "description": "Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": [ "winget" ], "description": "List of package managers to be disabled when detecting", "items": { "enum": [ "am", "apk", "brew", "choco", "dpkg", "emerge", "eopkg", "flatpak", "macports", "nix", "opkg", "pacman", "paludis", "pkg", "pkgtool", "rpm", "scoop", "snap", "winget", "xbps" ], "type": "string", "uniqueItems": true }, "type": "array" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
ce6b5954216428aa5b25c2bbc734c71e6874356b
2024-05-10T03:13:47
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default", "bright_black", "bright_red", "bright_green", "bright_yellow", "bright_blue", "bright_magenta", "bright_cyan", "bright_white", "dim_black", "dim_red", "dim_green", "dim_yellow", "dim_blue", "dim_magenta", "dim_cyan", "dim_white" ], "type": "string" }, "format": { "description": "Output format of the module", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/colors", "description": "Output color of the module" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "output": { "$ref": "#/$defs/colors", "description": "Set the color of the module output" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" }, "tsVersion": { "default": true, "description": "Whether to detect and display the version of terminal and shell. Mainly for benchmarking", "type": "boolean" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "break", "brightness", "camera", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "loadavg", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "anyOf": [ { "const": "bios", "description": "Print BIOS name, version, release date, etc" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "camera", "description": "Print available cameras" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "key": { "$ref": "#/$defs/key" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points\nThis option overrides other `show*` options", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "forceVulkan": { "default": false, "description": "Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point", "maximum": 9, "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "loadavg", "description": "Print system load averages" } }, "title": "Loadavg", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": [ "winget" ], "description": "List of package managers to be disabled when detecting", "items": { "enum": [ "am", "apk", "brew", "choco", "dpkg", "emerge", "eopkg", "flatpak", "macports", "nix", "opkg", "pacman", "paludis", "pkg", "pkgtool", "rpm", "scoop", "snap", "winget", "xbps" ], "type": "string", "uniqueItems": true }, "type": "array" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "ipv6": { "default": false, "description": "Whether to use IPv6 for public IP detection server", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "outputColor": { "$ref": "#/$defs/outputColor" }, "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
3430c10ec214fdf2f1d13603e3711f14fa58f5f5
2024-05-02T06:09:56
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default", "bright_black", "bright_red", "bright_green", "bright_yellow", "bright_blue", "bright_magenta", "bright_cyan", "bright_white" ], "type": "string" }, "format": { "description": "Output format of the module", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" }, "tsVersion": { "default": true, "description": "Whether to detect and display the version of terminal and shell. Mainly for benchmarking", "type": "boolean" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "osFile": { "description": "Set the path to the file containing OS information. Linux only", "type": "string" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "break", "brightness", "camera", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "anyOf": [ { "const": "bios", "description": "Print BIOS name, version, release date, etc" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "camera", "description": "Print available cameras" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "key": { "$ref": "#/$defs/key" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points\nThis option overrides other `show*` options", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "forceVulkan": { "default": false, "description": "Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": [ "winget" ], "description": "List of package managers to be disabled when detecting", "items": { "enum": [ "am", "apk", "brew", "choco", "dpkg", "emerge", "eopkg", "flatpak", "macports", "nix", "opkg", "pacman", "paludis", "pkg", "pkgtool", "rpm", "scoop", "snap", "winget", "xbps" ], "type": "string", "uniqueItems": true }, "type": "array" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
2d4e7f10c4954a1f8559fb362f75aa0a8afdb3ab
2024-05-21T01:21:03
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "italic_", "underline_", "blink_", "inverse_", "hidden_", "strike_", "light_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default" ], "type": "string" }, "format": { "description": "Output format of the module. See `-h &lt;module&gt;-format` for detail", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/colors", "description": "Output color of the module. Left empty to use `display.color.output`" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "output": { "$ref": "#/$defs/colors", "description": "Set the color of the module output" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" }, "tsVersion": { "default": true, "description": "Whether to detect and display the version of terminal and shell. Mainly for benchmarking", "type": "boolean" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "bootmgr", "break", "brightness", "camera", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "loadavg", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "physicalmemory", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "anyOf": [ { "const": "bios", "description": "Print information of 1st-stage bootloader (name, version, release date, etc)" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "bootmgr", "description": "Print information of 2nd-stage bootloader (name, firmware, etc)" }, { "const": "camera", "description": "Print available cameras" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "physicalmemory", "description": "Print system physical memory devices" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "showPeCoreCount": { "default": false, "description": "Detect and display CPU frequency of different core types (eg. Pcore and Ecore) if supported", "type": "boolean" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "key": { "$ref": "#/$defs/key" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points\nThis option overrides other `show*` options", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "detectionMethod": { "default": "auto", "description": "Force using a specified method to detect GPUs", "enum": [ "auto", "pci", "vulkan", "opengl" ], "type": "string" }, "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "showAllIps": { "default": false, "description": "Show all IPs bound to the same interface.\nBy default only the first IP is shown", "type": "boolean" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point", "maximum": 9, "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "loadavg", "description": "Print system load averages" } }, "title": "Loadavg", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": [ "winget" ], "description": "List of package managers to be disabled when detecting", "items": { "enum": [ "am", "apk", "brew", "choco", "dpkg", "emerge", "eopkg", "flatpak", "macports", "nix", "opkg", "pacman", "paludis", "pkg", "pkgtool", "rpm", "scoop", "snap", "winget", "xbps" ], "type": "string", "uniqueItems": true }, "type": "array" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "ipv6": { "default": false, "description": "Whether to use IPv6 for public IP detection server", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "outputColor": { "$ref": "#/$defs/outputColor" }, "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
be1791e386033d0ef036cb83b9e9957b86f8e0cd
2024-05-13T15:33:06
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "italic_", "underline_", "blink_", "inverse_", "hidden_", "strike_", "light_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default" ], "type": "string" }, "format": { "description": "Output format of the module", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/colors", "description": "Output color of the module. Left empty to use `display.color.output`" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "output": { "$ref": "#/$defs/colors", "description": "Set the color of the module output" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" }, "tsVersion": { "default": true, "description": "Whether to detect and display the version of terminal and shell. Mainly for benchmarking", "type": "boolean" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "break", "brightness", "camera", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "loadavg", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "anyOf": [ { "const": "bios", "description": "Print BIOS name, version, release date, etc" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "camera", "description": "Print available cameras" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "key": { "$ref": "#/$defs/key" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points\nThis option overrides other `show*` options", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "forceVulkan": { "default": false, "description": "Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "showAllIps": { "default": false, "description": "Show all IPs bound to the same interface.\nBy default only the first IP is shown", "type": "boolean" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point", "maximum": 9, "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "loadavg", "description": "Print system load averages" } }, "title": "Loadavg", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": [ "winget" ], "description": "List of package managers to be disabled when detecting", "items": { "enum": [ "am", "apk", "brew", "choco", "dpkg", "emerge", "eopkg", "flatpak", "macports", "nix", "opkg", "pacman", "paludis", "pkg", "pkgtool", "rpm", "scoop", "snap", "winget", "xbps" ], "type": "string", "uniqueItems": true }, "type": "array" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "ipv6": { "default": false, "description": "Whether to use IPv6 for public IP detection server", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "outputColor": { "$ref": "#/$defs/outputColor" }, "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
a8b734c8779be6affa9a341cbee58670a3dbcef9
2024-05-20T08:46:04
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "italic_", "underline_", "blink_", "inverse_", "hidden_", "strike_", "light_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default" ], "type": "string" }, "format": { "description": "Output format of the module. See `-h &lt;module&gt;-format` for detail", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/colors", "description": "Output color of the module. Left empty to use `display.color.output`" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "output": { "$ref": "#/$defs/colors", "description": "Set the color of the module output" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" }, "tsVersion": { "default": true, "description": "Whether to detect and display the version of terminal and shell. Mainly for benchmarking", "type": "boolean" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "bootmgr", "break", "brightness", "camera", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "loadavg", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "physicalmemory", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "anyOf": [ { "const": "bios", "description": "Print information of 1st-stage bootloader (name, version, release date, etc)" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "bootmgr", "description": "Print information of 2nd-stage bootloader (name, firmware, etc)" }, { "const": "camera", "description": "Print available cameras" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "physicalmemory", "description": "Print system physical memory devices" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "key": { "$ref": "#/$defs/key" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points\nThis option overrides other `show*` options", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "detectionMethod": { "default": "auto", "description": "Force using a specified method to detect GPUs", "enum": [ "auto", "pci", "vulkan", "opengl" ], "type": "string" }, "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "showAllIps": { "default": false, "description": "Show all IPs bound to the same interface.\nBy default only the first IP is shown", "type": "boolean" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point", "maximum": 9, "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "loadavg", "description": "Print system load averages" } }, "title": "Loadavg", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": [ "winget" ], "description": "List of package managers to be disabled when detecting", "items": { "enum": [ "am", "apk", "brew", "choco", "dpkg", "emerge", "eopkg", "flatpak", "macports", "nix", "opkg", "pacman", "paludis", "pkg", "pkgtool", "rpm", "scoop", "snap", "winget", "xbps" ], "type": "string", "uniqueItems": true }, "type": "array" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "ipv6": { "default": false, "description": "Whether to use IPv6 for public IP detection server", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "outputColor": { "$ref": "#/$defs/outputColor" }, "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
7d8c085254fb47e58dac0b1e538df193947eb4ba
2024-05-10T03:13:47
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default", "bright_black", "bright_red", "bright_green", "bright_yellow", "bright_blue", "bright_magenta", "bright_cyan", "bright_white", "dim_black", "dim_red", "dim_green", "dim_yellow", "dim_blue", "dim_magenta", "dim_cyan", "dim_white" ], "type": "string" }, "format": { "description": "Output format of the module", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/colors", "description": "Output color of the module" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "output": { "$ref": "#/$defs/colors", "description": "Set the color of the module output" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" }, "tsVersion": { "default": true, "description": "Whether to detect and display the version of terminal and shell. Mainly for benchmarking", "type": "boolean" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "break", "brightness", "camera", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "loadavg", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "anyOf": [ { "const": "bios", "description": "Print BIOS name, version, release date, etc" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "camera", "description": "Print available cameras" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "key": { "$ref": "#/$defs/key" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points\nThis option overrides other `show*` options", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "forceVulkan": { "default": false, "description": "Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point", "maximum": 9, "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "loadavg", "description": "Print system load averages" } }, "title": "Loadavg", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": [ "winget" ], "description": "List of package managers to be disabled when detecting", "items": { "enum": [ "am", "apk", "brew", "choco", "dpkg", "emerge", "eopkg", "flatpak", "macports", "nix", "opkg", "pacman", "paludis", "pkg", "pkgtool", "rpm", "scoop", "snap", "winget", "xbps" ], "type": "string", "uniqueItems": true }, "type": "array" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "ipv6": { "default": false, "description": "Whether to use IPv6 for public IP detection server", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "outputColor": { "$ref": "#/$defs/outputColor" }, "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
983e5c680f4ecc0e1c1f0bbdc77d183817c67136
2024-05-28T08:13:06
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "italic_", "underline_", "blink_", "inverse_", "hidden_", "strike_", "light_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default" ], "type": "string" }, "format": { "description": "Output format of the module. See `-h &lt;module&gt;-format` for detail", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/colors", "description": "Output color of the module. Left empty to use `display.color.output`" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "output": { "$ref": "#/$defs/colors", "description": "Set the color of the module output" }, "separator": { "$ref": "#/$defs/colors", "description": "Set the color of the key-value separator" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for multi-color bar, 3 for both, 6 for bar only, 9 for colored number, 10 for monochrome bar", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" }, "tsVersion": { "default": true, "description": "Whether to detect and display the version of terminal and shell. Mainly for benchmarking", "type": "boolean" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "bootmgr", "break", "brightness", "camera", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "editor", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "loadavg", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "physicalmemory", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "anyOf": [ { "const": "bios", "description": "Print information of 1st-stage bootloader (name, version, release date, etc)" }, { "const": "board", "description": "Print motherboard name and other info" }, { "const": "bootmgr", "description": "Print information of 2nd-stage bootloader (name, firmware, etc)" }, { "const": "camera", "description": "Print available cameras" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "editor", "description": "Print information of the default editor ($VISUAL or $EDITOR)" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "physicalmemory", "description": "Print system physical memory devices" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "showPeCoreCount": { "default": false, "description": "Detect and display CPU frequency of different core types (eg. Pcore and Ecore) if supported", "type": "boolean" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "key": { "$ref": "#/$defs/key" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points\nThis option overrides other `show*` options", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "detectionMethod": { "default": "auto", "description": "Force using a specified method to detect GPUs", "enum": [ "auto", "pci", "vulkan", "opengl" ], "type": "string" }, "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "showAllIps": { "default": false, "description": "Show all IPs bound to the same interface.\nBy default only the first IP is shown", "type": "boolean" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point", "maximum": 9, "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "loadavg", "description": "Print system load averages" } }, "title": "Loadavg", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": [ "winget" ], "description": "List of package managers to be disabled when detecting", "items": { "enum": [ "am", "apk", "brew", "choco", "dpkg", "emerge", "eopkg", "flatpak", "macports", "nix", "opkg", "pacman", "paludis", "pkg", "pkgtool", "rpm", "scoop", "snap", "winget", "xbps" ], "type": "string", "uniqueItems": true }, "type": "array" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "ipv6": { "default": false, "description": "Whether to use IPv6 for public IP detection server", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "outputColor": { "$ref": "#/$defs/outputColor" }, "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
fd0b35f21a125359c3574440fa2e6eac310ba978
2024-04-18T14:53:31
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default", "bright_black", "bright_red", "bright_green", "bright_yellow", "bright_blue", "bright_magenta", "bright_cyan", "bright_white" ], "type": "string" }, "format": { "description": "Output format of the module", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" }, "tsVersion": { "default": true, "description": "Whether to detect and display the version of terminal and shell. Mainly for benchmarking", "type": "boolean" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "osFile": { "description": "Set the path to the file containing OS information. Linux only", "type": "string" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "break", "brightness", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "anyOf": [ { "const": "bios", "description": "Print BIOS name, version, release date, etc" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "required": [ "format" ], "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "forceVulkan": { "default": false, "description": "Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": [ "winget" ], "description": "List of package managers to be disabled when detecting", "items": { "enum": [ "am", "apk", "brew", "choco", "dpkg", "emerge", "eopkg", "flatpak", "macports", "nix", "opkg", "pacman", "paludis", "pkg", "pkgtool", "rpm", "scoop", "snap", "winget", "xbps" ], "type": "string", "uniqueItems": true }, "type": "array" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
3d4077c2d02cc4f3171bc3189a6b0340823dcf90
2024-05-10T05:39:06
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "italic_", "underline_", "blink_", "inverse_", "hidden_", "strike_", "light_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default" ], "type": "string" }, "format": { "description": "Output format of the module", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/colors", "description": "Output color of the module. Left empty to use `display.color.output`" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "output": { "$ref": "#/$defs/colors", "description": "Set the color of the module output" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" }, "tsVersion": { "default": true, "description": "Whether to detect and display the version of terminal and shell. Mainly for benchmarking", "type": "boolean" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "break", "brightness", "camera", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "loadavg", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "anyOf": [ { "const": "bios", "description": "Print BIOS name, version, release date, etc" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "camera", "description": "Print available cameras" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "key": { "$ref": "#/$defs/key" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points\nThis option overrides other `show*` options", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "forceVulkan": { "default": false, "description": "Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point", "maximum": 9, "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "loadavg", "description": "Print system load averages" } }, "title": "Loadavg", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": [ "winget" ], "description": "List of package managers to be disabled when detecting", "items": { "enum": [ "am", "apk", "brew", "choco", "dpkg", "emerge", "eopkg", "flatpak", "macports", "nix", "opkg", "pacman", "paludis", "pkg", "pkgtool", "rpm", "scoop", "snap", "winget", "xbps" ], "type": "string", "uniqueItems": true }, "type": "array" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "ipv6": { "default": false, "description": "Whether to use IPv6 for public IP detection server", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "outputColor": { "$ref": "#/$defs/outputColor" }, "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
0f5e746fe2122932c13364042d373e3f8c7195bb
2024-05-09T01:40:53
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default", "bright_black", "bright_red", "bright_green", "bright_yellow", "bright_blue", "bright_magenta", "bright_cyan", "bright_white" ], "type": "string" }, "format": { "description": "Output format of the module", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/colors", "description": "Output color of the module" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "output": { "$ref": "#/$defs/colors", "description": "Set the color of the module output" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" }, "tsVersion": { "default": true, "description": "Whether to detect and display the version of terminal and shell. Mainly for benchmarking", "type": "boolean" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "break", "brightness", "camera", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "loadavg", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "anyOf": [ { "const": "bios", "description": "Print BIOS name, version, release date, etc" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "camera", "description": "Print available cameras" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "key": { "$ref": "#/$defs/key" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points\nThis option overrides other `show*` options", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "forceVulkan": { "default": false, "description": "Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point", "maximum": 9, "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "loadavg", "description": "Print system load averages" } }, "title": "Loadavg", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": [ "winget" ], "description": "List of package managers to be disabled when detecting", "items": { "enum": [ "am", "apk", "brew", "choco", "dpkg", "emerge", "eopkg", "flatpak", "macports", "nix", "opkg", "pacman", "paludis", "pkg", "pkgtool", "rpm", "scoop", "snap", "winget", "xbps" ], "type": "string", "uniqueItems": true }, "type": "array" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "outputColor": { "$ref": "#/$defs/outputColor" }, "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
acc77ebddd9f6f2aa42066958892bdab75ae2bd7
2024-05-09T07:54:49
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default", "bright_black", "bright_red", "bright_green", "bright_yellow", "bright_blue", "bright_magenta", "bright_cyan", "bright_white" ], "type": "string" }, "format": { "description": "Output format of the module", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/colors", "description": "Output color of the module" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "output": { "$ref": "#/$defs/colors", "description": "Set the color of the module output" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" }, "tsVersion": { "default": true, "description": "Whether to detect and display the version of terminal and shell. Mainly for benchmarking", "type": "boolean" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "break", "brightness", "camera", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "loadavg", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "anyOf": [ { "const": "bios", "description": "Print BIOS name, version, release date, etc" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "camera", "description": "Print available cameras" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "key": { "$ref": "#/$defs/key" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points\nThis option overrides other `show*` options", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "forceVulkan": { "default": false, "description": "Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point", "maximum": 9, "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "loadavg", "description": "Print system load averages" } }, "title": "Loadavg", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": [ "winget" ], "description": "List of package managers to be disabled when detecting", "items": { "enum": [ "am", "apk", "brew", "choco", "dpkg", "emerge", "eopkg", "flatpak", "macports", "nix", "opkg", "pacman", "paludis", "pkg", "pkgtool", "rpm", "scoop", "snap", "winget", "xbps" ], "type": "string", "uniqueItems": true }, "type": "array" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "ipv6": { "default": false, "description": "Whether to use IPv6 for public IP detection server", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "outputColor": { "$ref": "#/$defs/outputColor" }, "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
a2d99695fd6a3cdab8f64c70bbdbf5dcde948186
2024-04-04T02:42:44
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default", "bright_black", "bright_red", "bright_green", "bright_yellow", "bright_blue", "bright_magenta", "bright_cyan", "bright_white" ], "type": "string" }, "format": { "description": "Output format of the module", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "osFile": { "description": "Set the path to the file containing OS information. Linux only", "type": "string" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "break", "brightness", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "additionalProperties": false, "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "anyOf": [ { "const": "bios", "description": "Print BIOS name, version, release date, etc" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "required": [ "format" ], "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "forceVulkan": { "default": false, "description": "Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": "winget", "description": "A colon separated list of package managers to be disabled when detecting", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
3e24cdc7527c2712fa3bd0261736109943cb2523
2024-05-06T08:25:08
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default", "bright_black", "bright_red", "bright_green", "bright_yellow", "bright_blue", "bright_magenta", "bright_cyan", "bright_white" ], "type": "string" }, "format": { "description": "Output format of the module", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" }, "tsVersion": { "default": true, "description": "Whether to detect and display the version of terminal and shell. Mainly for benchmarking", "type": "boolean" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "break", "brightness", "camera", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "anyOf": [ { "const": "bios", "description": "Print BIOS name, version, release date, etc" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "camera", "description": "Print available cameras" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "key": { "$ref": "#/$defs/key" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points\nThis option overrides other `show*` options", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "forceVulkan": { "default": false, "description": "Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": [ "winget" ], "description": "List of package managers to be disabled when detecting", "items": { "enum": [ "am", "apk", "brew", "choco", "dpkg", "emerge", "eopkg", "flatpak", "macports", "nix", "opkg", "pacman", "paludis", "pkg", "pkgtool", "rpm", "scoop", "snap", "winget", "xbps" ], "type": "string", "uniqueItems": true }, "type": "array" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
ba60d9059fb6ab9a69f926ac6627216d62a2fa0c
2024-02-27T03:00:43
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default", "bright_black", "bright_red", "bright_green", "bright_yellow", "bright_blue", "bright_magenta", "bright_cyan", "bright_white" ], "type": "string" }, "format": { "description": "Output format of the module", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "percent": { "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "description": "Set how a percentage value should be displayed", "properties": { "color": { "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temperature": { "description": "Set how a temperature value should be displayed", "properties": { "color": { "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "osFile": { "description": "Set the path to the file containing OS information. Linux only", "type": "string" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "break", "brightness", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "anyOf": [ { "const": "bios", "description": "Print BIOS name, version, release date, etc" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } } }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth" }, { "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness" }, { "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU" }, { "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage" }, { "properties": { "block": { "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "required": [ "format" ], "title": "Custom" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO" }, { "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad" }, { "additionalProperties": false, "properties": { "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "forceVulkan": { "default": false, "description": "Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL" }, { "properties": { "disabled": { "default": "winget", "description": "A colon separated list of package managers to be disabled when detecting", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP" }, { "additionalProperties": false, "properties": { "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } } }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather" }, { "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
dc94ac8d0c5d39604dab7b3331c24183c1971704
2024-05-14T02:25:29
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "italic_", "underline_", "blink_", "inverse_", "hidden_", "strike_", "light_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default" ], "type": "string" }, "format": { "description": "Output format of the module. See `-h &lt;module&gt;-format` for detail", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/colors", "description": "Output color of the module. Left empty to use `display.color.output`" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "output": { "$ref": "#/$defs/colors", "description": "Set the color of the module output" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" }, "tsVersion": { "default": true, "description": "Whether to detect and display the version of terminal and shell. Mainly for benchmarking", "type": "boolean" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "break", "brightness", "camera", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "loadavg", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "anyOf": [ { "const": "bios", "description": "Print BIOS name, version, release date, etc" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "camera", "description": "Print available cameras" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "key": { "$ref": "#/$defs/key" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points\nThis option overrides other `show*` options", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "forceVulkan": { "default": false, "description": "Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "showAllIps": { "default": false, "description": "Show all IPs bound to the same interface.\nBy default only the first IP is shown", "type": "boolean" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point", "maximum": 9, "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "loadavg", "description": "Print system load averages" } }, "title": "Loadavg", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": [ "winget" ], "description": "List of package managers to be disabled when detecting", "items": { "enum": [ "am", "apk", "brew", "choco", "dpkg", "emerge", "eopkg", "flatpak", "macports", "nix", "opkg", "pacman", "paludis", "pkg", "pkgtool", "rpm", "scoop", "snap", "winget", "xbps" ], "type": "string", "uniqueItems": true }, "type": "array" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "ipv6": { "default": false, "description": "Whether to use IPv6 for public IP detection server", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "outputColor": { "$ref": "#/$defs/outputColor" }, "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
374997b599a3bfa8b94636e3b55b0dc21eb7baf4
2024-05-24T11:50:26
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "italic_", "underline_", "blink_", "inverse_", "hidden_", "strike_", "light_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default" ], "type": "string" }, "format": { "description": "Output format of the module. See `-h &lt;module&gt;-format` for detail", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/colors", "description": "Output color of the module. Left empty to use `display.color.output`" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "output": { "$ref": "#/$defs/colors", "description": "Set the color of the module output" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for multi-color bar, 3 for both, 6 for bar only, 9 for colored number, 10 for monochrome bar", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" }, "tsVersion": { "default": true, "description": "Whether to detect and display the version of terminal and shell. Mainly for benchmarking", "type": "boolean" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "bootmgr", "break", "brightness", "camera", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "editor", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "loadavg", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "physicalmemory", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "anyOf": [ { "const": "bios", "description": "Print information of 1st-stage bootloader (name, version, release date, etc)" }, { "const": "board", "description": "Print motherboard name and other info" }, { "const": "bootmgr", "description": "Print information of 2nd-stage bootloader (name, firmware, etc)" }, { "const": "camera", "description": "Print available cameras" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "editor", "description": "Print information of the default editor ($VISUAL or $EDITOR)" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "physicalmemory", "description": "Print system physical memory devices" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "showPeCoreCount": { "default": false, "description": "Detect and display CPU frequency of different core types (eg. Pcore and Ecore) if supported", "type": "boolean" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "key": { "$ref": "#/$defs/key" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points\nThis option overrides other `show*` options", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "detectionMethod": { "default": "auto", "description": "Force using a specified method to detect GPUs", "enum": [ "auto", "pci", "vulkan", "opengl" ], "type": "string" }, "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "showAllIps": { "default": false, "description": "Show all IPs bound to the same interface.\nBy default only the first IP is shown", "type": "boolean" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point", "maximum": 9, "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "loadavg", "description": "Print system load averages" } }, "title": "Loadavg", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": [ "winget" ], "description": "List of package managers to be disabled when detecting", "items": { "enum": [ "am", "apk", "brew", "choco", "dpkg", "emerge", "eopkg", "flatpak", "macports", "nix", "opkg", "pacman", "paludis", "pkg", "pkgtool", "rpm", "scoop", "snap", "winget", "xbps" ], "type": "string", "uniqueItems": true }, "type": "array" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "ipv6": { "default": false, "description": "Whether to use IPv6 for public IP detection server", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "outputColor": { "$ref": "#/$defs/outputColor" }, "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
30a5dd52b1df7180a4bca0beff67c05a40b95d40
2024-05-22T08:32:27
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "italic_", "underline_", "blink_", "inverse_", "hidden_", "strike_", "light_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default" ], "type": "string" }, "format": { "description": "Output format of the module. See `-h &lt;module&gt;-format` for detail", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/colors", "description": "Output color of the module. Left empty to use `display.color.output`" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "output": { "$ref": "#/$defs/colors", "description": "Set the color of the module output" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" }, "tsVersion": { "default": true, "description": "Whether to detect and display the version of terminal and shell. Mainly for benchmarking", "type": "boolean" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "bootmgr", "break", "brightness", "camera", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "editor", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "loadavg", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "physicalmemory", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "anyOf": [ { "const": "bios", "description": "Print information of 1st-stage bootloader (name, version, release date, etc)" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "bootmgr", "description": "Print information of 2nd-stage bootloader (name, firmware, etc)" }, { "const": "camera", "description": "Print available cameras" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "editor", "description": "Print information of the default editor ($VISUAL or $EDITOR)" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "physicalmemory", "description": "Print system physical memory devices" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "showPeCoreCount": { "default": false, "description": "Detect and display CPU frequency of different core types (eg. Pcore and Ecore) if supported", "type": "boolean" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "key": { "$ref": "#/$defs/key" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points\nThis option overrides other `show*` options", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "detectionMethod": { "default": "auto", "description": "Force using a specified method to detect GPUs", "enum": [ "auto", "pci", "vulkan", "opengl" ], "type": "string" }, "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "showAllIps": { "default": false, "description": "Show all IPs bound to the same interface.\nBy default only the first IP is shown", "type": "boolean" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point", "maximum": 9, "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "loadavg", "description": "Print system load averages" } }, "title": "Loadavg", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": [ "winget" ], "description": "List of package managers to be disabled when detecting", "items": { "enum": [ "am", "apk", "brew", "choco", "dpkg", "emerge", "eopkg", "flatpak", "macports", "nix", "opkg", "pacman", "paludis", "pkg", "pkgtool", "rpm", "scoop", "snap", "winget", "xbps" ], "type": "string", "uniqueItems": true }, "type": "array" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "ipv6": { "default": false, "description": "Whether to use IPv6 for public IP detection server", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "outputColor": { "$ref": "#/$defs/outputColor" }, "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
6326405c26c5a8ef4f02a830b30e8a39d751f133
2024-05-24T02:19:58
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "italic_", "underline_", "blink_", "inverse_", "hidden_", "strike_", "light_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default" ], "type": "string" }, "format": { "description": "Output format of the module. See `-h &lt;module&gt;-format` for detail", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/colors", "description": "Output color of the module. Left empty to use `display.color.output`" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "output": { "$ref": "#/$defs/colors", "description": "Set the color of the module output" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for multi-color bar, 3 for both, 6 for bar only, 9 for colored number, 10 for monochrome bar", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" }, "tsVersion": { "default": true, "description": "Whether to detect and display the version of terminal and shell. Mainly for benchmarking", "type": "boolean" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "bootmgr", "break", "brightness", "camera", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "editor", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "loadavg", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "physicalmemory", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "anyOf": [ { "const": "bios", "description": "Print information of 1st-stage bootloader (name, version, release date, etc)" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "bootmgr", "description": "Print information of 2nd-stage bootloader (name, firmware, etc)" }, { "const": "camera", "description": "Print available cameras" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "editor", "description": "Print information of the default editor ($VISUAL or $EDITOR)" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "physicalmemory", "description": "Print system physical memory devices" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "showPeCoreCount": { "default": false, "description": "Detect and display CPU frequency of different core types (eg. Pcore and Ecore) if supported", "type": "boolean" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "key": { "$ref": "#/$defs/key" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points\nThis option overrides other `show*` options", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "detectionMethod": { "default": "auto", "description": "Force using a specified method to detect GPUs", "enum": [ "auto", "pci", "vulkan", "opengl" ], "type": "string" }, "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "showAllIps": { "default": false, "description": "Show all IPs bound to the same interface.\nBy default only the first IP is shown", "type": "boolean" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point", "maximum": 9, "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "loadavg", "description": "Print system load averages" } }, "title": "Loadavg", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": [ "winget" ], "description": "List of package managers to be disabled when detecting", "items": { "enum": [ "am", "apk", "brew", "choco", "dpkg", "emerge", "eopkg", "flatpak", "macports", "nix", "opkg", "pacman", "paludis", "pkg", "pkgtool", "rpm", "scoop", "snap", "winget", "xbps" ], "type": "string", "uniqueItems": true }, "type": "array" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "ipv6": { "default": false, "description": "Whether to use IPv6 for public IP detection server", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "outputColor": { "$ref": "#/$defs/outputColor" }, "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
ea1ef0f34731ad50e277f6a0b1a37fce739c9c92
2024-04-23T14:51:22
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default", "bright_black", "bright_red", "bright_green", "bright_yellow", "bright_blue", "bright_magenta", "bright_cyan", "bright_white" ], "type": "string" }, "format": { "description": "Output format of the module", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" }, "tsVersion": { "default": true, "description": "Whether to detect and display the version of terminal and shell. Mainly for benchmarking", "type": "boolean" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "osFile": { "description": "Set the path to the file containing OS information. Linux only", "type": "string" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "break", "brightness", "camera", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "anyOf": [ { "const": "bios", "description": "Print BIOS name, version, release date, etc" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "camera", "description": "Print available cameras" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "required": [ "format" ], "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "forceVulkan": { "default": false, "description": "Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": [ "winget" ], "description": "List of package managers to be disabled when detecting", "items": { "enum": [ "am", "apk", "brew", "choco", "dpkg", "emerge", "eopkg", "flatpak", "macports", "nix", "opkg", "pacman", "paludis", "pkg", "pkgtool", "rpm", "scoop", "snap", "winget", "xbps" ], "type": "string", "uniqueItems": true }, "type": "array" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
bc76220a5b45c87bcb68eb1985d2eb582c68dd5b
2024-05-16T10:48:27
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "italic_", "underline_", "blink_", "inverse_", "hidden_", "strike_", "light_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default" ], "type": "string" }, "format": { "description": "Output format of the module. See `-h &lt;module&gt;-format` for detail", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/colors", "description": "Output color of the module. Left empty to use `display.color.output`" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "output": { "$ref": "#/$defs/colors", "description": "Set the color of the module output" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" }, "tsVersion": { "default": true, "description": "Whether to detect and display the version of terminal and shell. Mainly for benchmarking", "type": "boolean" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "bootmgr", "break", "brightness", "camera", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "loadavg", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "physicalmemory", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "anyOf": [ { "const": "bios", "description": "Print information of 1st-stage bootloader (name, version, release date, etc)" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "bootmgr", "description": "Print information of 2nd-stage bootloader (name, firmware, etc)" }, { "const": "camera", "description": "Print available cameras" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "physicalmemory", "description": "Print system physical memory devices" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "key": { "$ref": "#/$defs/key" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points\nThis option overrides other `show*` options", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "forceVulkan": { "default": false, "description": "Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "showAllIps": { "default": false, "description": "Show all IPs bound to the same interface.\nBy default only the first IP is shown", "type": "boolean" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point", "maximum": 9, "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "loadavg", "description": "Print system load averages" } }, "title": "Loadavg", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": [ "winget" ], "description": "List of package managers to be disabled when detecting", "items": { "enum": [ "am", "apk", "brew", "choco", "dpkg", "emerge", "eopkg", "flatpak", "macports", "nix", "opkg", "pacman", "paludis", "pkg", "pkgtool", "rpm", "scoop", "snap", "winget", "xbps" ], "type": "string", "uniqueItems": true }, "type": "array" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "ipv6": { "default": false, "description": "Whether to use IPv6 for public IP detection server", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "outputColor": { "$ref": "#/$defs/outputColor" }, "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
6c88981b05c9731f998adeaaa8350bb54557c3a5
2024-02-28T01:17:29
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default", "bright_black", "bright_red", "bright_green", "bright_yellow", "bright_blue", "bright_magenta", "bright_cyan", "bright_white" ], "type": "string" }, "format": { "description": "Output format of the module", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "osFile": { "description": "Set the path to the file containing OS information. Linux only", "type": "string" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "break", "brightness", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "additionalProperties": false, "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "anyOf": [ { "const": "bios", "description": "Print BIOS name, version, release date, etc" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "required": [ "format" ], "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "forceVulkan": { "default": false, "description": "Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": "winget", "description": "A colon separated list of package managers to be disabled when detecting", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
9cb08d115a9341666b32eef49164e556a120f0bf
2024-05-08T08:11:16
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default", "bright_black", "bright_red", "bright_green", "bright_yellow", "bright_blue", "bright_magenta", "bright_cyan", "bright_white" ], "type": "string" }, "format": { "description": "Output format of the module", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/colors", "description": "Output color of the module" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "output": { "$ref": "#/$defs/colors", "description": "Set the color of the module output" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" }, "tsVersion": { "default": true, "description": "Whether to detect and display the version of terminal and shell. Mainly for benchmarking", "type": "boolean" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "break", "brightness", "camera", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "anyOf": [ { "const": "bios", "description": "Print BIOS name, version, release date, etc" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "camera", "description": "Print available cameras" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "key": { "$ref": "#/$defs/key" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points\nThis option overrides other `show*` options", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "forceVulkan": { "default": false, "description": "Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": [ "winget" ], "description": "List of package managers to be disabled when detecting", "items": { "enum": [ "am", "apk", "brew", "choco", "dpkg", "emerge", "eopkg", "flatpak", "macports", "nix", "opkg", "pacman", "paludis", "pkg", "pkgtool", "rpm", "scoop", "snap", "winget", "xbps" ], "type": "string", "uniqueItems": true }, "type": "array" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "outputColor": { "$ref": "#/$defs/outputColor" }, "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
738daa1c7770f1935d898e6c37c901003b0fae7a
2024-05-08T10:34:34
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default", "bright_black", "bright_red", "bright_green", "bright_yellow", "bright_blue", "bright_magenta", "bright_cyan", "bright_white" ], "type": "string" }, "format": { "description": "Output format of the module", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "outputColor": { "$ref": "#/$defs/colors", "description": "Output color of the module" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "output": { "$ref": "#/$defs/colors", "description": "Set the color of the module output" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" }, "tsVersion": { "default": true, "description": "Whether to detect and display the version of terminal and shell. Mainly for benchmarking", "type": "boolean" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "break", "brightness", "camera", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "loadavg", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "anyOf": [ { "const": "bios", "description": "Print BIOS name, version, release date, etc" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "camera", "description": "Print available cameras" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "key": { "$ref": "#/$defs/key" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points\nThis option overrides other `show*` options", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "forceVulkan": { "default": false, "description": "Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "loadavg", "description": "Print system load averages" } }, "title": "Loadavg", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": [ "winget" ], "description": "List of package managers to be disabled when detecting", "items": { "enum": [ "am", "apk", "brew", "choco", "dpkg", "emerge", "eopkg", "flatpak", "macports", "nix", "opkg", "pacman", "paludis", "pkg", "pkgtool", "rpm", "scoop", "snap", "winget", "xbps" ], "type": "string", "uniqueItems": true }, "type": "array" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "outputColor": { "$ref": "#/$defs/outputColor" }, "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "outputColor": { "$ref": "#/$defs/outputColor" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
fastfetch-cli/fastfetch
81480532e2c60c12d96ae36ea57a2d7b7f07a8ab
2024-05-01T07:54:30
doc/json_schema.json
6,819
2024-05-29T11:02:54.506501Z
{ "$defs": { "colors": { "enum": [ "reset_", "bright_", "dim_", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default", "bright_black", "bright_red", "bright_green", "bright_yellow", "bright_blue", "bright_magenta", "bright_cyan", "bright_white" ], "type": "string" }, "format": { "description": "Output format of the module", "type": "string" }, "key": { "description": "Key of the module", "type": "string" }, "keyColor": { "$ref": "#/$defs/colors", "description": "Color of the module key. Left empty to use `display.color.keys`" }, "keyWidth": { "default": 0, "description": "Width of the module key. Use 0 to use `display.keyWidth`", "minimum": 0, "type": "integer" }, "percent": { "additionalProperties": false, "description": "Threshold of percentage colors", "properties": { "green": { "description": "Value less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" }, "temperature": { "description": "Detect and display temperature if supported", "oneOf": [ { "default": false, "type": "boolean" }, { "additionalProperties": false, "properties": { "green": { "description": "Value (in celsius) less then green will be shown in green", "maximum": 100, "minimum": 0, "type": "integer" }, "yellow": { "description": "Value (in celsius) greater than green and less then yellow will be shown in yellow.\nValue greater than yellow will be shown in red", "maximum": 100, "minimum": 0, "type": "integer" } }, "type": "object" } ] } }, "$schema": "https://json-schema.org/draft-07/schema", "additionalProperties": false, "description": "JSON config file for fastfetch. Usually be `~/.config/fastfetch.jsonc`", "properties": { "$schema": { "default": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json", "description": "JSON schema URL, for JSON validation and IDE intelligence", "format": "uri", "type": "string" }, "display": { "additionalProperties": false, "description": "Configure how things to be displayed", "properties": { "bar": { "additionalProperties": false, "description": "Set the bar configuration", "properties": { "border": { "default": true, "description": "Whether to show a border around the bar", "type": "boolean" }, "charElapsed": { "default": "\u25a0", "description": "Set the character to use in elapsed part", "type": "string" }, "charTotal": { "default": "-", "description": "Set the character to use in total part", "type": "string" }, "width": { "default": 10, "description": "Set the width of the bar, in number of characters", "minimum": 1, "type": "integer" } }, "type": "object" }, "binaryPrefix": { "description": "Set the binary prefix to used when printing bytes", "oneOf": [ { "const": "iec", "description": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)" }, { "const": "si", "description": "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." }, { "const": "jedec", "description": "1024 Bytes = 1 kB, 1024 K = 1 MB, ..." } ], "type": "string" }, "brightColor": { "default": true, "description": "Set if the keys, title and ASCII logo should be printed in bright color", "type": "boolean" }, "color": { "description": "Set the color of the keys and title", "oneOf": [ { "$ref": "#/$defs/colors", "description": "Set the both color of the keys and title" }, { "additionalProperties": false, "properties": { "keys": { "$ref": "#/$defs/colors", "description": "Set the color of the keys" }, "title": { "$ref": "#/$defs/colors", "description": "Set the color of the title" } }, "type": "object" } ] }, "disableLinewrap": { "default": true, "description": "Whether to disable line wrap during the run", "type": "boolean" }, "hideCursor": { "default": true, "description": "Whether to hide the cursor during the run", "type": "boolean" }, "keyWidth": { "default": 0, "description": "Align the width of keys to number of characters, 0 to disable", "minimum": 0, "type": "integer" }, "noBuffer": { "default": false, "description": "Whether to disable the stdout application buffer", "type": "boolean" }, "percent": { "additionalProperties": false, "description": "Set how a percentage value should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of percentage bars and numbers", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 0, "description": "Set the number of digits to keep after the decimal point when formatting percentage numbers", "maximum": 9, "minimum": 0, "type": "number" }, "type": { "default": 9, "description": "Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" }, "pipe": { "default": false, "description": "Whether to enable pipe mode (disable logo and all escape sequences)", "type": "boolean" }, "separator": { "default": ": ", "description": "Set the separator between key and value", "type": "string" }, "showErrors": { "default": false, "description": "Print occurring errors to the console. False to ignore errored modules", "type": "boolean" }, "size": { "additionalProperties": false, "description": "Set how a size value should be displayed", "properties": { "maxPrefix": { "default": "YB", "description": "Set the largest binary prefix to use when formatting sizes", "enum": [ "B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" ], "type": "string" }, "ndigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when formatting sizes", "maximum": 9, "minimum": 0, "type": "integer" } }, "type": "object" }, "stat": { "default": false, "description": "Show time usage (in ms) for individual modules", "type": "boolean" }, "temp": { "additionalProperties": false, "description": "Set how temperature values should be displayed", "properties": { "color": { "additionalProperties": false, "description": "Set color used in different states of temperature values", "properties": { "green": { "$ref": "#/$defs/colors", "description": "Color used in green state" }, "red": { "$ref": "#/$defs/colors", "description": "Color used in red state" }, "yellow": { "$ref": "#/$defs/colors", "description": "Color used in yellow state" } }, "type": "object" }, "ndigits": { "default": 1, "description": "Set the number of digits to keep after the decimal point when formatting temperature values", "maximum": 9, "minimum": 0, "type": "integer" }, "unit": { "default": "C", "description": "Set the unit of the temperature", "enum": [ "CELSIUS", "C", "FAHRENHEIT", "F", "KELVIN", "K" ], "type": "string" } }, "type": "object" }, "tsVersion": { "default": true, "description": "Whether to detect and display the version of terminal and shell. Mainly for benchmarking", "type": "boolean" } }, "type": "object" }, "general": { "additionalProperties": false, "description": "Fastfetch general configurations", "properties": { "dsForceDrm": { "default": false, "description": "Force display detection to use DRM. Linux only", "oneOf": [ { "const": false, "description": "Try `wayland`, then `x11`, then `drm`", "type": "boolean" }, { "const": "sysfs-only", "description": "Use `/sys/class/drm` only.", "type": "string" }, { "const": true, "description": "Try `libdrm` first, then `sysfs` if libdrm failed", "type": "boolean" } ] }, "escapeBedrock": { "default": true, "description": "On Bedrock Linux, whether to escape the bedrock jail", "type": "boolean" }, "multithreading": { "default": true, "description": "Use multiple threads to detect values", "type": "boolean" }, "osFile": { "description": "Set the path to the file containing OS information. Linux only", "type": "string" }, "playerName": { "description": "The name of the player to use for module Media and Player. Linux only", "type": "string" }, "processingTimeout": { "default": 1000, "description": "Set the timeout (ms) when waiting for child processes, `-1` for no timeout", "type": "integer" }, "thread": { "default": true, "description": "Alias of multithreading", "type": "boolean" }, "wmiTimeout": { "default": 5000, "description": "Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only", "type": "integer" } }, "type": "object" }, "library": { "additionalProperties": false, "description": "Set the path of a library to load", "properties": { "chafa": { "description": "Image output as ascii art (Linux, FreeBSD, macOS)", "type": "string" }, "dbus": { "description": "Bluetooth, Player & Media detection (Linux, FreeBSD)", "type": "string" }, "dconf": { "description": "Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)", "type": "string" }, "ddcutil": { "description": "Used for brightness detection of external displays (Linux)", "type": "string" }, "drm": { "description": "Used for fast resolution and refresh rate detection (Linux)", "type": "string" }, "egl": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "freetype": { "description": "Used for Termux font detection (Android)", "type": "string" }, "gio": { "description": "Needed for values that are only stored GSettings (Linux, FreeBSD)", "type": "string" }, "glx": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "imagemagick": { "description": "Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" }, "nm": { "description": "NetworkManager. Used for Wifi detection (Linux)", "type": "string" }, "opencl": { "description": "OpenCL module (Linux, FreeBSD, Windows)", "type": "string" }, "osmesa": { "description": "Needed by the OpenGL module for gl context creation (Linux, FreeBSD)", "type": "string" }, "pci": { "description": "GPU output (Linux and FreeBSD)", "type": "string" }, "pulse": { "description": "Pulseaudio. Used for Sound detection (Linux, FreeBSD)", "type": "string" }, "rpm": { "description": "Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)", "type": "string" }, "sqlite3": { "description": "Needed for pkg & rpm package count (Linux, FreeBSD)", "type": "string" }, "vulkan": { "description": "Vulkan module & fallback for GPU output", "type": "string" }, "wayland": { "description": "Better display performance and output in wayland sessions.\nSupports different refresh rates per monitor.\n(Linux, FreeBSD)", "type": "string" }, "x11": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcb": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xcbRandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "xfconf": { "description": "Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)", "type": "string" }, "xrandr": { "description": "X11 sessions for better display detection and faster WM detection.\nThe *randr ones provide multi monitor support The libxcb* ones usually have better performance.\n (Linux, FreeBSD)", "type": "string" }, "z": { "description": "Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)", "type": "string" } }, "type": "object" }, "logo": { "oneOf": [ { "description": "Disable logo", "type": "null" }, { "description": "Set the source file of the logo", "type": "string" }, { "additionalProperties": false, "description": "Fastfetch logo configurations", "properties": { "chafa": { "additionalProperties": false, "description": "Chafa configuration. See chafa document for details", "properties": { "canvasMode": { "description": "Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.", "enum": [ "TRUECOLOR", "INDEXED_256", "INDEXED_240", "INDEXED_16", "FGBG_BGFG", "FGBG", "INDEXED_8", "INDEXED_16_8" ], "type": "string" }, "colorSpace": { "description": "Set color space used for quantization. This value maps the value of enum ChafaColorSpace.", "enum": [ "RGB", "DIN99D" ], "type": "string" }, "ditherMode": { "description": "Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.", "enum": [ "NONE", "ORDERED", "DIFFUSION" ], "type": "string" }, "fgOnly": { "default": false, "description": "Produce character-cell output using foreground colors only", "type": "boolean" }, "symbols": { "description": "Specify character symbols to employ in final output", "type": "string" } }, "type": "object" }, "color": { "additionalProperties": false, "description": "Overwrite a color in the logo", "properties": { "1": { "$ref": "#/$defs/colors", "description": "Color 1" }, "2": { "$ref": "#/$defs/colors", "description": "Color 2" }, "3": { "$ref": "#/$defs/colors", "description": "Color 3" }, "4": { "$ref": "#/$defs/colors", "description": "Color 4" }, "5": { "$ref": "#/$defs/colors", "description": "Color 5" }, "6": { "$ref": "#/$defs/colors", "description": "Color 6" }, "7": { "$ref": "#/$defs/colors", "description": "Color 7" }, "8": { "$ref": "#/$defs/colors", "description": "Color 8" }, "9": { "$ref": "#/$defs/colors", "description": "Color 9" } }, "type": "object" }, "height": { "description": "Set the height of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" }, "padding": { "additionalProperties": false, "description": "Set the padding of the logo", "properties": { "left": { "description": "Set the left padding of the logo", "minimum": 0, "type": "integer" }, "right": { "description": "Set the right padding of the logo", "minimum": 0, "type": "integer" }, "top": { "description": "Set the top padding of the logo", "minimum": 0, "type": "integer" } }, "type": "object" }, "preserveAspectRatio": { "default": false, "description": "Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol", "type": "boolean" }, "printRemaining": { "default": false, "description": "Whether to print the remaining logo, if it has more lines than modules to display", "type": "boolean" }, "recache": { "default": false, "description": "If true, regenerate image logo cache", "type": "boolean" }, "separate": { "default": false, "description": "If true, print modules at bottom of the logo", "type": "boolean" }, "source": { "description": "Set the source file of the logo", "type": "string" }, "type": { "default": "auto", "description": "Set the type of the logo given", "enum": [ "auto", "builtin", "small", "file", "file-raw", "data", "data-raw", "sixel", "kitty", "kitty-direct", "iterm", "chafa", "raw", "none" ] }, "width": { "description": "Set the width of the logo (in characters). Required for iTerm image protocol", "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "modules": { "description": "Fastfetch modules to run", "items": { "anyOf": [ { "description": "Run module with default configurations", "enum": [ "battery", "bios", "bluetooth", "board", "break", "brightness", "camera", "chassis", "cpu", "cpuusage", "command", "colors", "cursor", "datetime", "display", "disk", "diskio", "de", "font", "gamepad", "gpu", "host", "icons", "kernel", "lm", "locale", "localip", "media", "memory", "monitor", "netio", "opencl", "opengl", "os", "packages", "physicaldisk", "player", "poweradapter", "processes", "publicip", "separator", "shell", "sound", "swap", "terminal", "terminalfont", "terminalsize", "terminaltheme", "title", "theme", "uptime", "users", "version", "vulkan", "wallpaper", "weather", "wm", "wifi", "wmtheme" ], "type": "string" }, { "description": "Run module with custom configurations", "oneOf": [ { "additionalProperties": false, "properties": { "type": { "const": "break", "description": "Print a empty line" } }, "title": "Break", "type": "object" }, { "additionalProperties": false, "description": "No additional properties", "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "anyOf": [ { "const": "bios", "description": "Print BIOS name, version, release date, etc" }, { "const": "board", "description": "Print mather board name and other info" }, { "const": "camera", "description": "Print available cameras" }, { "const": "cursor", "description": "Print cursor style name" }, { "const": "datetime", "description": "Print current date and time" }, { "const": "font", "description": "Print system font name" }, { "const": "host", "description": "Print product name of your computer" }, { "const": "icons", "description": "Print icon style name" }, { "const": "kernel", "description": "Print system kernel version" }, { "const": "lm", "description": "Print login manager (desktop manager) name and version" }, { "const": "locale", "description": "Print system locale name" }, { "const": "media", "description": "Print playing song name" }, { "const": "monitor", "description": "Print connected physical monitor information" }, { "const": "opencl", "description": "Print highest OpenCL version supported by the GPU" }, { "const": "os", "description": "Print operating system name and version" }, { "const": "player", "description": "Print music player name" }, { "const": "poweradapter", "description": "Print power adapter name and charging watts" }, { "const": "processes", "description": "Count running processes" }, { "const": "shell", "description": "Print current shell name and version" }, { "const": "terminal", "description": "Print current terminal name and version" }, { "const": "terminalfont", "description": "Print font name and size used by current terminal" }, { "const": "terminalsize", "description": "Print current terminal size" }, { "const": "terminaltheme", "description": "Print current terminal theme (foreground and background colors)" }, { "const": "theme", "description": "Print current theme of desktop environment" }, { "const": "uptime", "description": "Print how long system has been running" }, { "const": "users", "description": "Print users currently logged in" }, { "const": "version", "description": "Print Fastfetch version" }, { "const": "vulkan", "description": "Print highest Vulkan version supported by the GPU" }, { "const": "wallpaper", "description": "Print image file path of current wallpaper" }, { "const": "wifi", "description": "Print connected Wi-Fi info (SSID, connection and security protocol)" }, { "const": "wmtheme", "description": "Print current theme of window manager" } ] } }, "title": "module", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "battery", "description": "Print battery capacity, status, etc" }, "useSetupApi": { "default": false, "description": "Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only", "type": "boolean" } }, "title": "Battery", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "showDisconnected": { "default": false, "description": "Set if disconnected bluetooth devices should be printed", "type": "boolean" }, "type": { "const": "bluetooth", "description": "List bluetooth devices" } }, "title": "Bluetooth", "type": "object" }, { "additionalProperties": false, "properties": { "ddcciSleep": { "default": 10, "description": "Set the sleep times (in ms) when sending DDC/CI requests.\nSee <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail", "maximum": 400, "minimum": 0, "type": "integer" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "brightness", "description": "Print current brightness level of your monitors" } }, "title": "Brightness", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "chassis", "description": "Print chassis type (desktop, laptop, etc)" } }, "title": "Chassis", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "freqNdigits": { "default": 2, "description": "Set the number of digits to keep after the decimal point when printing CPU frequency", "maximum": 9, "minimum": 0, "type": "integer" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "cpu", "description": "Print CPU name, frequency, etc" } }, "title": "CPU", "type": "object" }, { "additionalProperties": false, "properties": { "percent": { "$ref": "#/$defs/percent" }, "separate": { "default": false, "description": "Display CPU usage per CPU logical core, instead of an average result", "type": "boolean" }, "type": { "const": "cpuusage", "description": "Print CPU usage. Costs some time to collect data" } }, "title": "CPU Usage", "type": "object" }, { "additionalProperties": false, "properties": { "block": { "additionalProperties": false, "description": "Set behavior of block printing", "properties": { "range": { "description": "Set the range of colors in the blocks to print", "items": { "maximum": 15, "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "width": { "default": 3, "description": "Set the block width in spaces", "minimum": 1, "type": "integer" } }, "type": "object" }, "key": { "$ref": "#/$defs/key" }, "paddingLeft": { "default": 0, "description": "Set the number of white spaces to print before the symbol", "minimum": 0, "type": "integer" }, "symbol": { "default": "block", "description": "Set the symbol to use", "enum": [ "block", "circle", "diamond", "triangle", "square", "star" ], "type": "string" }, "type": { "const": "colors", "description": "Print some colored blocks" } }, "title": "Colors", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "shell": { "description": "Set the shell program to execute the command text\nDefault: cmd for Windows, /bin/sh for *nix", "type": "string" }, "text": { "description": "Set the command text to be executed", "type": "string" }, "type": { "const": "command", "description": "Running custom shell scripts" } }, "title": "Command", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "description": "Text to print", "type": "string" }, "key": { "description": "Leave empty not to print the key", "type": "string" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "custom", "description": "Print a custom string, with or without key" } }, "title": "Custom", "type": "object" }, { "additionalProperties": false, "properties": { "compactType": { "default": "none", "description": "Set if all displays should be printed in one line", "enum": [ "none", "original", "scaled", "original-with-refresh-rate", "scaled-with-refresh-rate" ] }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "order": { "default": "none", "description": "Set the order should be used when printing", "enum": [ "none", "asc", "desc" ] }, "preciseRefreshRate": { "default": false, "description": "Set if decimal refresh rates should not be rounded into integers when printing", "type": "boolean" }, "type": { "const": "display", "description": "Print resolutions, refresh rates, etc" } }, "title": "Display", "type": "object" }, { "additionalProperties": false, "properties": { "folders": { "description": "A colon (semicolon on Windows) separated list of folder paths for the disk output\nDefault: auto detection using mount-points", "type": "string" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "showExternal": { "default": true, "description": "Set if external volume should be printed", "type": "boolean" }, "showHidden": { "default": false, "description": "Set if hidden volumes should be printed", "type": "boolean" }, "showReadOnly": { "default": false, "description": "Set if read only volumes should be printed", "type": "boolean" }, "showSubvolumes": { "default": false, "description": "Set if subvolumes should be printed", "type": "boolean" }, "showUnknown": { "default": false, "description": "Set if unknown (unable to detect sizes) volumes should be printed", "type": "boolean" }, "type": { "const": "disk", "description": "Print partitions, space usage, disk type, etc" }, "useAvailable": { "default": false, "description": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes", "type": "boolean" } }, "title": "Disk", "type": "object" }, { "additionalProperties": false, "properties": { "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "type": { "const": "diskio", "description": "Print physical disk I/O throughput" } }, "title": "DiskIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "slowVersionDetection": { "default": "false", "description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.", "type": "boolean" }, "type": { "const": "de", "description": "Print desktop environment name" } }, "title": "DE", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "gamepad", "description": "List connected gamepads" } }, "title": "Gamepad", "type": "object" }, { "additionalProperties": false, "properties": { "driverSpecific": { "default": false, "description": "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)", "type": "boolean" }, "forceVulkan": { "default": false, "description": "Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "hideType": { "default": "none", "description": "Specify the type of GPUs should not be printed", "enum": [ "integrated", "discrete", "none" ] }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "gpu", "description": "Print GPU names, graphic memory size, type, etc" } }, "title": "GPU", "type": "object" }, { "additionalProperties": false, "properties": { "compact": { "default": false, "description": "Show all IPs in one line", "type": "boolean" }, "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "showIpv4": { "default": true, "description": "Show IPv4 addresses", "type": "boolean" }, "showIpv6": { "default": false, "description": "Show IPv6 addresses", "type": "boolean" }, "showLoop": { "default": false, "description": "Show loop back addresses (127.0.0.1)", "type": "boolean" }, "showMac": { "default": false, "description": "Show MAC addresses", "type": "boolean" }, "showPrefixLen": { "default": true, "description": "Show network prefix length (/N)", "type": "boolean" }, "type": { "const": "localip", "description": "List local IP addresses (v4 or v6), MAC addresses, etc" } }, "title": "Local IP", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "memory", "description": "Print system memory usage info" } }, "title": "Memory", "type": "object" }, { "additionalProperties": false, "properties": { "defaultRouteOnly": { "default": true, "description": "Show ips that are used for default routing only", "type": "boolean" }, "detectTotal": { "default": false, "description": "Detect total bytes instead of current rate", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show IPs with given name prefix only", "type": "string" }, "type": { "const": "netio", "description": "Print network I/O throughput" } }, "title": "NetIO", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "library": { "default": "auto", "description": "Set the OpenGL context creation library to use. Linux only", "enum": [ "auto", "egl", "glx", "osmesa" ] }, "type": { "const": "opengl", "description": "Print highest OpenGL version supported by the GPU" } }, "title": "OpenGL", "type": "object" }, { "additionalProperties": false, "properties": { "disabled": { "default": [ "winget" ], "description": "List of package managers to be disabled when detecting", "items": { "enum": [ "am", "apk", "brew", "choco", "dpkg", "emerge", "eopkg", "flatpak", "macports", "nix", "opkg", "pacman", "paludis", "pkg", "pkgtool", "rpm", "scoop", "snap", "winget", "xbps" ], "type": "string", "uniqueItems": true }, "type": "array" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "packages", "description": "List installed package managers and count of installed packages" } }, "title": "Packages", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "namePrefix": { "description": "Show disks with given name prefix only", "type": "string" }, "temp": { "$ref": "#/$defs/temperature" }, "type": { "const": "physicaldisk", "description": "Print physical disk information" } }, "title": "Physical Disk", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the public ip server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "publicip", "description": "Print your public IP address, etc" }, "url": { "default": "http://ipinfo.io/ip", "description": "The URL of public IP detection server to be used. Only HTTP protocol is supported", "format": "url", "type": "string" } }, "title": "Public IP", "type": "object" }, { "additionalProperties": false, "properties": { "string": { "default": "-", "description": "Set the string to be printed", "type": "string" }, "type": { "const": "separator", "description": "Print a separator line" } }, "title": "Separator", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "soundType": { "default": "main", "description": "Set what type of sound devices should be printed", "enum": [ "main", "active", "all" ], "type": "string" }, "type": { "const": "sound", "description": "Print sound devices, volume, etc" } }, "title": "Sound", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "percent": { "$ref": "#/$defs/percent" }, "type": { "const": "swap", "description": "Print swap (paging file) space usage" } }, "title": "Swap", "type": "object" }, { "additionalProperties": false, "properties": { "color": { "additionalProperties": false, "description": "Set colors of the different part of title", "properties": { "at": { "$ref": "#/$defs/colors", "description": "Set color of the @ symbol (middle part)" }, "host": { "$ref": "#/$defs/colors", "description": "Set color of the host name (right part)" }, "user": { "$ref": "#/$defs/colors", "description": "Set color of the user name (left part)" } }, "type": "object" }, "format": { "$ref": "#/$defs/format" }, "fqdn": { "default": false, "description": "Set if the title should use fully qualified domain name", "type": "boolean" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "title", "description": "Print title, which contains your user name, hostname" } }, "title": "Title", "type": "object" }, { "additionalProperties": false, "properties": { "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "location": { "description": "The location to display", "type": "string" }, "outputFormat": { "default": "%t+-+%C+(%l)", "description": "The output weather format to be used (must be URI encoded)", "type": "string" }, "timeout": { "default": "disabled (0)", "description": "Time in milliseconds to wait for the weather server to respond", "minimum": 0, "type": "integer" }, "type": { "const": "weather", "description": "Print weather information" } }, "title": "Weather", "type": "object" }, { "additionalProperties": false, "properties": { "detectPlugin": { "default": false, "description": "Set if window manager plugin should be detected on supported platforms", "type": "boolean" }, "format": { "$ref": "#/$defs/format" }, "key": { "$ref": "#/$defs/key" }, "keyColor": { "$ref": "#/$defs/keyColor" }, "keyWidth": { "$ref": "#/$defs/keyWidth" }, "type": { "const": "wm", "description": "Print window manager name and version" } }, "title": "WM", "type": "object" } ], "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } ] }, "type": "array" } }, "title": "JSON config", "type": "object" }
MIT
en
raystack/stencil
efce4dae1327a2eb5cbe66b8c100cf254ba60344
2023-10-26T00:15:31
formats/json/testdata/array/2020items.json
214
2024-05-29T10:18:12.592384Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "This object represents Collections in a SpatioTemporal Asset Catalog.", "properties": { "example": { "prefixItems": [ { "type": "string" }, { "type": "number" } ], "type": "array" } }, "title": "STAC Collection Specification" }
Apache-2.0
en
raystack/stencil
efce4dae1327a2eb5cbe66b8c100cf254ba60344
2023-10-26T00:15:31
formats/json/testdata/array/2020prefixItems.json
214
2024-05-29T10:18:12.592384Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "This object represents Collections in a SpatioTemporal Asset Catalog.", "properties": { "example": { "items": { "type": "integer" }, "prefixItems": [ { "type": "string" }, { "type": "number" }, { "type": "string" } ], "type": "array" } }, "title": "STAC Collection Specification" }
Apache-2.0
en
raystack/stencil
efce4dae1327a2eb5cbe66b8c100cf254ba60344
2023-10-26T00:15:31
formats/json/testdata/array/2020updated.json
214
2024-05-29T10:18:12.592384Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "This object represents Collections in a SpatioTemporal Asset Catalog.", "properties": { "example": { "items": { "type": "integer" }, "prefixItems": [ { "type": "string" }, { "type": "string" } ], "type": "array" } }, "title": "STAC Collection Specification" }
Apache-2.0
en
raystack/stencil
efce4dae1327a2eb5cbe66b8c100cf254ba60344
2023-10-26T00:15:31
formats/json/testdata/array/2020prev.json
214
2024-05-29T10:18:12.592384Z
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "This object represents Collections in a SpatioTemporal Asset Catalog.", "properties": { "example": { "items": { "type": "integer" }, "prefixItems": [ { "type": "string" }, { "type": "number" } ], "type": "array" } }, "title": "STAC Collection Specification" }
Apache-2.0
en
Scirra/Construct-Plugin-Steamworks
d4a8ff4aa1d2432dbb0630f486224e0892924c74
2024-01-10T11:36:35
plugin.lang.schema.json
7
2024-05-27T06:11:11.243561Z
{ "$defs": { "acEntry": { "additionalProperties": false, "description": "Language strings for conditions or actions by their ID.", "properties": { "description": { "description": "A description of the action or condition, which appears as a tip at the top of the condition/action picker dialog.", "type": "string" }, "display-text": { "description": "The text that appears in the event sheet. You can use simple BBCode tags like [b] and [i], and use {0}, {1} etc. as parameter placeholders.", "type": "string" }, "list-name": { "description": "The name that appears in the condition/action picker dialog.", "type": "string" }, "params": { "additionalProperties": { "additionalProperties": false, "description": "Language strings for a parameter of a condition or action by the parameter ID.", "properties": { "desc": { "description": "Language string for a parameter description.", "type": "string" }, "items": { "$ref": "#/$defs/comboItems" }, "name": { "description": "Language string for a parameter name.", "type": "string" } }, "required": [ "name", "desc" ], "type": "object" }, "description": "Language strings for parameters of a condition or action.", "type": "object" } }, "required": [ "list-name", "display-text", "description" ], "type": "object" }, "comboItems": { "additionalProperties": { "description": "Language string for a combo item, with the item ID as the key.", "type": "string" }, "description": "Items for a combo property or parameter.", "minProperties": 1, "type": "object" }, "expEntry": { "additionalProperties": false, "description": "Language strings for expressions by their ID.", "properties": { "description": { "description": "A description of the action or condition, which appears as a tip at the top of the condition/action picker dialog.", "type": "string" }, "params": { "additionalProperties": { "additionalProperties": false, "description": "Language strings for a parameter of an expression by the parameter ID.", "properties": { "desc": { "description": "Language string for a parameter description.", "type": "string" }, "name": { "description": "Language string for a parameter name.", "type": "string" } }, "required": [ "name", "desc" ], "type": "object" }, "description": "Language strings for parameters of an expression.", "type": "object" }, "translated-name": { "description": "The translated name of the expression, which must be a valid expression identifier (e.g. no quotes/apostrophes or other characters with special meaning in expressions). Note for en-US this must match the expression name." } }, "required": [ "description", "translated-name" ], "type": "object" } }, "$id": "https://construct.net/sdk/schema/plugin.lang.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "The language file with strings for a plugin.", "properties": { "fileDescription": { "description": "Optional description for this file (as a comment only).", "type": "string" }, "languageTag": { "description": "An IETF language tag defining the translation language, e.g. \"en-US\".", "type": "string" }, "text": { "additionalProperties": false, "properties": { "plugins": { "additionalProperties": { "properties": { "aceCategories": { "additionalProperties": { "description": "Language string for an action/condition/expression category.", "type": "string" }, "description": "Language strings for action/condition/expression categories.", "type": "object" }, "actions": { "additionalProperties": { "$ref": "#/$defs/acEntry" }, "type": "object" }, "conditions": { "additionalProperties": { "$ref": "#/$defs/acEntry" }, "type": "object" }, "description": { "description": "The description of the plugin.", "type": "string" }, "expressions": { "additionalProperties": { "$ref": "#/$defs/expEntry" }, "type": "object" }, "help-url": { "description": "A URL for documentation or support.", "format": "uri", "type": "string" }, "name": { "description": "The display name of the plugin.", "type": "string" }, "properties": { "additionalProperties": { "additionalProperties": false, "description": "Language strings for a plugin property by its ID.", "properties": { "desc": { "description": "Description of this plugin property.", "type": "string" }, "items": { "$ref": "#/$defs/comboItems" }, "link-text": { "description": "Link text for a \"link\" type property.", "type": "string" }, "name": { "description": "Name of this plugin property.", "type": "string" } }, "required": [ "name", "desc" ], "type": "object" }, "description": "Language strings for plugin properties.", "type": "object" } }, "required": [ "name", "description", "help-url" ], "type": "object" }, "maxProperties": 1, "minProperties": 1, "type": "object" } }, "required": [ "plugins" ], "type": "object" } }, "required": [ "languageTag", "text" ], "title": "Plugin language file JSON", "type": "object" }
MIT
en
Scirra/Construct-Plugin-Steamworks
d4a8ff4aa1d2432dbb0630f486224e0892924c74
2024-01-10T11:36:35
aces.schema.json
7
2024-05-27T06:11:11.243561Z
{ "$defs": { "acParameter": { "description": "A parameter for a condition or action.", "properties": { "allowedPluginIds": { "description": "Optional and only valid with the \"object\" type. Set to an array of plugin IDs allowed to be shown by the object picker. For example, use [\"Sprite\"] to only allow the object parameter to select a Sprite.", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "c2id": { "description": "In some circumstances, it is necessary to specify which Construct 2 parameter ID a parameter corresponds to. However normally it can be inferred by the parameter index.", "type": "number" }, "id": { "description": "A string with a unique identifier for this parameter.", "type": "string" }, "initialValue": { "description": "A string which is used as the initial expression for expression-based parameters. Note this is still a string for \"number\" type parameters. It can contain any valid expression for the parameter, such as \"1 + 1\". For \"boolean\" parameters, use a string of either \"true\" or \"false\". For \"combo\" parameters, this is the initial item ID.", "type": "string" }, "items": { "description": "Only valid with the \"combo\" type. Set to an array of item IDs available in the dropdown list.", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "type": { "description": "The parameter type.", "enum": [ "number", "string", "any", "boolean", "combo", "cmp", "object", "objectname", "layer", "layout", "keyb", "instancevar", "instancevarbool", "eventvar", "eventvarbool", "animation", "objinstancevar" ] } }, "required": [ "id", "type" ], "type": "object" }, "expParameter": { "description": "A parameter for an expression.", "properties": { "c2id": { "description": "In some circumstances, it is necessary to specify which Construct 2 parameter ID a parameter corresponds to. However normally it can be inferred by the parameter index.", "type": "number" }, "id": { "description": "A string with a unique identifier for this parameter.", "type": "string" }, "type": { "description": "The parameter type.", "enum": [ "number", "string", "any" ] } }, "required": [ "id", "type" ], "type": "object" } }, "$id": "https://construct.net/sdk/schema/plugin.addon.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": { "description": "ACE definitions for a specific category.", "properties": { "actions": { "description": "Action definitions for this category.", "items": { "additionalProperties": false, "description": "Action definition", "properties": { "c2id": { "description": "If you are porting a Construct 2 addon to Construct 3, put the corresponding numerical ID that the Construct 2 addon used here. This allows Construct 3 to import Construct 2 projects using your addon.", "type": "number" }, "highlight": { "description": "Set to true to highlight the action in the picker dialog.", "type": "boolean" }, "id": { "description": "A string specifying a unique ID for the action.", "type": "string" }, "isAsync": { "description": "Set to true to mark the action as asynchronous. Make the action method an async function, and the system 'Wait for previous actions to complete' action will be able to wait for the action as well.", "type": "boolean" }, "isDeprecated": { "description": "Set to true to deprecate the action. This hides it in the editor, but allows existing projects to continue using it.", "type": "boolean" }, "params": { "description": "Array of parameters for this action.", "items": { "$ref": "#/$defs/acParameter" }, "type": "array" }, "scriptName": { "description": "The name of the function in the runtime script for this action.", "type": "string" } }, "required": [ "id", "scriptName" ], "type": "object" }, "type": "array" }, "conditions": { "description": "Condition definitions for this category.", "items": { "additionalProperties": false, "description": "Condition definition", "properties": { "c2id": { "description": "If you are porting a Construct 2 addon to Construct 3, put the corresponding numerical ID that the Construct 2 addon used here. This allows Construct 3 to import Construct 2 projects using your addon.", "type": "number" }, "highlight": { "description": "Set to true to highlight the condition in the picker dialog.", "type": "boolean" }, "id": { "description": "A string specifying a unique ID for the condition.", "type": "string" }, "isCompatibleWithTriggers": { "description": "Allow the condition to be used in the same branch as a trigger. Set to false if the condition does not make sense when used in a trigger, such as the Trigger once condition.", "type": "boolean" }, "isDeprecated": { "description": "Set to true to deprecate the condition. This hides it in the editor, but allows existing projects to continue using it.", "type": "boolean" }, "isFakeTrigger": { "description": "Specifies a fake trigger. This appears identical to a trigger in the event sheet, but is actually evaluated every tick. This is useful for conditions which are true for a single tick, such as for APIs which must poll a value every tick.", "type": "boolean" }, "isInvertible": { "description": "Allow the condition to be inverted in the event sheet. Set to false to disable invert.", "type": "boolean" }, "isLooping": { "description": "Display an icon in the event sheet to indicate the condition loops. This should only be used with conditions which implement re-triggering.", "type": "boolean" }, "isStatic": { "description": "Normally, the condition runtime method is executed once per picked instance. If the condition is marked static, the runtime method is executed once only, on the object type class. This means the runtime method must also implement the instance picking entirely itself, including respecting negation and OR blocks.", "type": "boolean" }, "isTrigger": { "description": "Specifies a trigger condition. This appears with an arrow in the event sheet. Instead of being evaluated every tick, triggers only run when they are explicity triggered by a runtime call.", "type": "boolean" }, "params": { "description": "Array of parameters for this condition.", "items": { "$ref": "#/$defs/acParameter" }, "type": "array" }, "scriptName": { "description": "The name of the function in the runtime script for this condition.", "type": "string" } }, "required": [ "id", "scriptName" ], "type": "object" }, "type": "array" }, "expressions": { "description": "Expression definitions for this category.", "items": { "additionalProperties": false, "description": "Expression definition", "properties": { "c2id": { "description": "If you are porting a Construct 2 addon to Construct 3, put the corresponding numerical ID that the Construct 2 addon used here. This allows Construct 3 to import Construct 2 projects using your addon.", "type": "number" }, "expressionName": { "description": "The name typed in by the user for this expression, which is also used as the name of the function in the runtime script.", "type": "string" }, "highlight": { "description": "Set to true to highlight the expression in the picker dialog.", "type": "boolean" }, "id": { "description": "A string specifying a unique ID for the expression.", "type": "string" }, "isDeprecated": { "description": "Set to true to deprecate the expression. This hides it in the editor, but allows existing projects to continue using it.", "type": "boolean" }, "isVariadicParameters": { "description": "If true, Construct will allow the user to enter any number of parameters beyond those defined. In other words the parameters (if any) listed in \"params\" are required, but this flag enables adding further \"any\" type parameters beyond the end.", "type": "boolean" }, "params": { "description": "Array of parameters for this action.", "items": { "$ref": "#/$defs/expParameter" }, "type": "array" }, "returnType": { "description": "The type of value returned by the expression.", "enum": [ "number", "string", "any" ] } }, "required": [ "id", "expressionName" ], "type": "object" }, "type": "array" } }, "type": "object" }, "description": "Plugin JSON file that describes the available actions, conditions and expressions.", "properties": { "$schema": { "type": "string" } }, "title": "Plugin aces.json", "type": "object" }
MIT
en
Scirra/Construct-Plugin-Steamworks
d4a8ff4aa1d2432dbb0630f486224e0892924c74
2024-01-10T11:36:35
plugin.addon.schema.json
7
2024-05-27T06:11:11.243561Z
{ "$id": "https://construct.net/sdk/schema/plugin.addon.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Main JSON file that describes metadata about a plugin.", "properties": { "author": { "description": "A string identifying the author of the addon.", "type": "string" }, "description": { "description": "A string of a brief description of what the addon does, displayed when prompting the user to install the addon.", "type": "string" }, "documentation": { "description": "A string of a URL to the online documentation for the addon. It is important to provide documentation for your addon to be useful to users.", "format": "uri", "type": "string" }, "editor-scripts": { "description": "An array of script files in the addon package to load in the editor.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true }, "file-list": { "description": "A list of all files used by the addon. Required for Developer Mode addons to work.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "The unique ID of the addon. This must not be used by any other addon ever published for Construct, and must never change after you first publish your addon. It is recommended to use a vendor-specific prefix, e.g. MyCompany_MyAddon.", "type": "string" }, "is-c3-addon": { "const": true, "description": "This is used by Construct to identify valid addons." }, "name": { "description": "The displayed name of the addon, in English. This can be changed after release.", "type": "string" }, "type": { "const": "plugin", "description": "Indicates the addon type. For the plugin schema, this must be \"plugin\"." }, "version": { "description": "A string specifying the addon version in four parts (major, minor, patch, revision).", "type": "string" }, "website": { "description": "A string of a URL to the author's website. It is recommended to provide updates to the addon at this URL if any become available. The website should use HTTPS.", "format": "uri", "type": "string" } }, "required": [ "is-c3-addon", "type", "name", "id", "version", "author", "website", "documentation", "description", "editor-scripts" ], "title": "Plugin addon.json", "type": "object" }
MIT
en
pyrox0/fursona-schema
f6ccc064af12f0c97700d148181b6f0c4a14ee75
2023-04-20T00:50:10
schema.json
55
2024-05-27T03:44:47.19335Z
{ "$defs": { "sona": { "$id": "/schemas/sona", "description": "A single fursona", "properties": { "age": { "type": "integer" }, "avatar": { "format": "uri", "qt-uri-protocols": [ "http", "https", "gemeni", "ftp" ], "type": "string" }, "colors": { "items": { "pattern": "#([0-9a-f]){3,6}", "type": "string" }, "type": "array" }, "description": { "maxLength": 250, "type": "string" }, "gender": { "type": "string" }, "name": { "type": "string" }, "pronouns": { "type": "string" }, "ref": { "format": "uri", "qt-uri-protocols": [ "http", "https", "gemini", "ftp" ], "type": "string" }, "species": { "type": "string" } }, "type": "object" } }, "$id": "https://pyrox.dev/schemas/sonas", "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "A description of someone's fursona(s).", "properties": { "sonas": { "description": "The list of fursonas for this person.", "items": { "$ref": "/schemas/sona" }, "type": "array" } }, "required": [ "sonas" ], "title": "Schema for .well-known/fursona", "type": "object" }
CC-BY-4.0
en
pyrox0/fursona-schema
e876de9edc28a15677ad83e310163b0c59e2e74e
2023-05-05T12:33:49
schema.json
55
2024-05-27T03:44:47.19335Z
{ "$defs": { "sona": { "$id": "/schemas/sona", "description": "A single fursona", "properties": { "age": { "type": "integer" }, "avatar": { "format": "uri", "qt-uri-protocols": [ "http", "https", "gemini", "ftp" ], "type": "string" }, "birthdate": { "type": "string" }, "colors": { "items": { "pattern": "#([0-9a-f]){3,6}", "type": "string" }, "type": "array" }, "description": { "maxLength": 250, "type": "string" }, "gender": { "type": "string" }, "name": { "type": "string" }, "pronouns": { "type": "string" }, "ref": { "format": "uri", "qt-uri-protocols": [ "http", "https", "gemini", "ftp" ], "type": "string" }, "species": { "type": "string" } }, "type": "object" } }, "$id": "https://pyrox.dev/schemas/sonas", "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "A description of someone's fursona(s).", "properties": { "sonas": { "description": "The list of fursonas for this person.", "items": { "$ref": "/schemas/sona" }, "type": "array" } }, "required": [ "sonas" ], "title": "Schema for .well-known/fursona", "type": "object" }
CC-BY-4.0
en
pyrox0/fursona-schema
87b78e5a9e8f4a7d433e1284cca2ab80c4fe1aaf
2023-04-19T02:55:44
schema.json
55
2024-05-27T03:44:47.19335Z
{ "$defs": { "sona": { "$id": "/schemas/sona", "description": "A single fursona", "properties": { "age": { "type": "integer" }, "colors": { "items": { "pattern": "#([0-9a-f]){3,6}", "type": "string" }, "type": "array" }, "gender": { "type": "string" }, "name": { "type": "string" }, "profile-picture": { "format": "uri", "qt-uri-protocols": [ "http", "https", "gemeni", "ftp" ], "type": "string" }, "pronouns": { "type": "string" }, "ref": { "format": "uri", "qt-uri-protocols": [ "http", "https", "gemini", "ftp" ], "type": "string" }, "species": { "type": "string" } }, "type": "object" } }, "$id": "https://pyrox.dev/schemas/sonas", "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "A description of someone's fursona(s).", "properties": { "sonas": { "description": "The list of fursonas for this person.", "items": { "$ref": "/schemas/sona" }, "type": "array" } }, "required": [ "sonas" ], "title": "Schema for .well-known/fursona", "type": "object" }
CC-BY-4.0
en
pyrox0/fursona-schema
108585a3834db72bfa8247836bd8809cf44c45b8
2023-04-19T03:12:55
schema.json
55
2024-05-27T03:44:47.19335Z
{ "$defs": { "sona": { "$id": "/schemas/sona", "description": "A single fursona", "properties": { "age": { "type": "integer" }, "colors": { "items": { "pattern": "#([0-9a-f]){3,6}", "type": "string" }, "type": "array" }, "description": { "maxLength": 250, "type": "string" }, "gender": { "type": "string" }, "name": { "type": "string" }, "profile-picture": { "format": "uri", "qt-uri-protocols": [ "http", "https", "gemeni", "ftp" ], "type": "string" }, "pronouns": { "type": "string" }, "ref": { "format": "uri", "qt-uri-protocols": [ "http", "https", "gemini", "ftp" ], "type": "string" }, "species": { "type": "string" } }, "type": "object" } }, "$id": "https://pyrox.dev/schemas/sonas", "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "A description of someone's fursona(s).", "properties": { "sonas": { "description": "The list of fursonas for this person.", "items": { "$ref": "/schemas/sona" }, "type": "array" } }, "required": [ "sonas" ], "title": "Schema for .well-known/fursona", "type": "object" }
CC-BY-4.0
en
pyrox0/fursona-schema
ce339eaff393a72c9c86cc8533bc1286b53b82fe
2023-04-19T02:43:08
schema.json
55
2024-05-27T03:44:47.19335Z
{ "$defs": { "sona": { "$id": "/schemas/sona", "description": "A single fursona", "properties": { "age": { "type": "integer" }, "colors": { "items": { "pattern": "#([0-9][a-f]){3,6}", "type": "string" }, "type": "array" }, "description": { "maxLength": 250, "type": "string" }, "gender": { "type": "string" }, "name": { "type": "string" }, "profile-picture": { "format": "uri", "qt-uri-protocols": [ "http", "https", "gemeni", "ftp" ], "type": "string" }, "pronouns": { "type": "string" }, "ref": { "format": "uri", "qt-uri-protocols": [ "http", "https", "gemini", "ftp" ], "type": "string" }, "species": { "type": "string" } }, "type": "object" } }, "$id": "https://pyrox.dev/schemas/sonas", "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "A description of someone's fursona(s).", "properties": { "sonas": { "description": "The list of fursonas for this person.", "items": { "$ref": "/schemas/sona" }, "type": "array" } }, "required": [ "sonas" ], "title": "Schema for .well-known/fursona", "type": "object" }
CC-BY-4.0
en
pyrox0/fursona-schema
dca26847a2640f8ef3997cfda906523978fd1d4b
2023-03-15T21:30:26
schema.json
55
2024-05-27T03:44:47.19335Z
{ "$defs": { "sona": { "$id": "/schemas/sona", "description": "A single fursona", "properties": { "age": { "type": "integer" }, "colors": { "items": { "pattern": "#([0-9][a-f]){3,6}", "type": "string" }, "type": "array" }, "gender": { "type": "string" }, "name": { "type": "string" }, "pronouns": { "type": "string" }, "ref": { "format": "uri", "qt-uri-protocols": [ "http", "https", "gemeni", "ftp" ], "type": "string" }, "species": { "type": "string" } }, "type": "object" } }, "$id": "https://pyrox.dev/schemas/sonas", "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "A description of someone's fursona(s).", "properties": { "sonas": { "description": "The list of fursonas for this person.", "items": { "$ref": "/schemas/sona" }, "type": "array" } }, "required": [ "sonas" ], "title": "Schema for .well-known/fursona", "type": "object" }
CC-BY-4.0
en
pyrox0/fursona-schema
24ad14d23f1e4fb37a7c644ed15addff1c2762a5
2023-04-18T12:24:44
schema.json
55
2024-05-27T03:44:47.19335Z
{ "$defs": { "sona": { "$id": "/schemas/sona", "description": "A single fursona", "properties": { "age": { "type": "integer" }, "colors": { "items": { "pattern": "#([0-9][a-f]){3,6}", "type": "string" }, "type": "array" }, "gender": { "type": "string" }, "name": { "type": "string" }, "profile-picture": { "format": "uri", "qt-uri-protocols": [ "http", "https", "gemeni", "ftp" ], "type": "string" }, "pronouns": { "type": "string" }, "ref": { "format": "uri", "qt-uri-protocols": [ "http", "https", "gemini", "ftp" ], "type": "string" }, "species": { "type": "string" } }, "type": "object" } }, "$id": "https://pyrox.dev/schemas/sonas", "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "A description of someone's fursona(s).", "properties": { "sonas": { "description": "The list of fursonas for this person.", "items": { "$ref": "/schemas/sona" }, "type": "array" } }, "required": [ "sonas" ], "title": "Schema for .well-known/fursona", "type": "object" }
CC-BY-4.0
en
pyrox0/fursona-schema
c0ed3284a9f78bdb3be42e4a9000cd3abcad0a20
2023-05-02T17:07:33
schema.json
55
2024-05-27T03:44:47.19335Z
{ "$defs": { "sona": { "$id": "/schemas/sona", "description": "A single fursona", "properties": { "age": { "type": "integer" }, "avatar": { "format": "uri", "qt-uri-protocols": [ "http", "https", "gemeni", "ftp" ], "type": "string" }, "birthdate": { "type": "string" }, "colors": { "items": { "pattern": "#([0-9a-f]){3,6}", "type": "string" }, "type": "array" }, "description": { "maxLength": 250, "type": "string" }, "gender": { "type": "string" }, "name": { "type": "string" }, "pronouns": { "type": "string" }, "ref": { "format": "uri", "qt-uri-protocols": [ "http", "https", "gemini", "ftp" ], "type": "string" }, "species": { "type": "string" } }, "type": "object" } }, "$id": "https://pyrox.dev/schemas/sonas", "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "A description of someone's fursona(s).", "properties": { "sonas": { "description": "The list of fursonas for this person.", "items": { "$ref": "/schemas/sona" }, "type": "array" } }, "required": [ "sonas" ], "title": "Schema for .well-known/fursona", "type": "object" }
CC-BY-4.0
en
pyrox0/fursona-schema
de091268069712755313cefc25c27b5f0b459102
2023-03-15T21:33:23
schema.json
55
2024-05-27T03:44:47.19335Z
{ "$defs": { "sona": { "$id": "/schemas/sona", "description": "A single fursona", "properties": { "age": { "type": "integer" }, "colors": { "items": { "pattern": "#([0-9][a-f]){3,6}", "type": "string" }, "type": "array" }, "gender": { "type": "string" }, "name": { "type": "string" }, "pronouns": { "type": "string" }, "ref": { "format": "uri", "qt-uri-protocols": [ "http", "https", "gemini", "ftp" ], "type": "string" }, "species": { "type": "string" } }, "type": "object" } }, "$id": "https://pyrox.dev/schemas/sonas", "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "A description of someone's fursona(s).", "properties": { "sonas": { "description": "The list of fursonas for this person.", "items": { "$ref": "/schemas/sona" }, "type": "array" } }, "required": [ "sonas" ], "title": "Schema for .well-known/fursona", "type": "object" }
CC-BY-4.0
en
kit-data-manager/metastore2
f6e28ee9d6125450d0920254edfcfb6c9908f397
2022-03-11T06:42:28
src/main/resources/static/jsonSchemas/metadataRecordForCreate.json
5
2024-05-28T02:23:16.441484Z
{ "$id": "http://www.example.org/schema/json", "$schema": "https://json-schema.org/draft/2019-09/schema", "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "READ", "WRITE", "ADMINISTRATE", "NONE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "Sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "id": { "title": "Identifier", "type": "string" }, "metadataDocument": { "title": "Metadata Document", "type": "string" }, "relatedResource": { "properties": { "identifier": { "title": "Identifier*", "type": "string" }, "identifierType": { "default": "INTERNAL", "title": "Identifier Type*", "type": "string" } }, "required": [ "identifier", "identifierType" ], "title": "Related Resource", "type": "object" }, "schema": { "properties": { "identifier": { "title": "Identifier*", "type": "string" }, "identifierType": { "enum": [ "URL", "INTERNAL" ], "title": "Identifier Type*", "type": "string" } }, "required": [ "identifier", "identifierType" ], "title": "Schema", "type": "object" }, "schemaVersion": { "title": "Schema Version", "type": "integer" } }, "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
b7d4394b937cea77e8ce42862d29b3a3e8e9e48a
2022-03-08T07:58:33
src/main/resources/static/jsonSchemas/metadataRecordForCreate.json
5
2024-05-28T02:23:16.441484Z
{ "$id": "http://www.example.org/schema/json", "$schema": "https://json-schema.org/draft/2019-09/schema", "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "READ", "WRITE", "ADMINISTRATE", "NONE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "Sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "metadataDocument": { "title": "Metadata Document", "type": "string" }, "relatedResource": { "properties": { "identifier": { "title": "Identifier*", "type": "string" }, "identifierType": { "default": "INTERNAL", "title": "Identifier Type*", "type": "string" } }, "required": [ "identifier", "identifierType" ], "title": "Related Resource", "type": "object" }, "schema": { "properties": { "identifier": { "title": "Identifier*", "type": "string" }, "identifierType": { "enum": [ "URL", "INTERNAL" ], "title": "Identifier Type*", "type": "string" } }, "required": [ "identifier", "identifierType" ], "title": "Schema", "type": "object" }, "schemaVersion": { "title": "Schema Version", "type": "integer" } }, "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
4406ffb9197376533f78f35d6cc11fe35eae7ed2
2021-12-09T10:39:47
src/main/resources/static/jsonSchemas/metadataRecordForCreate.json
5
2024-05-28T02:23:16.441484Z
{ "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "READ", "WRITE", "ADMINISTRATE", "NONE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "Sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "relatedResource": { "properties": { "identifier": { "title": "Identifier", "type": "string" }, "identifierType": { "default": "INTERNAL", "title": "Identifier Type", "type": "string" } }, "required": [ "identifier", "identifierType" ], "title": "Related Resource", "type": "object" }, "schema": { "properties": { "identifier": { "title": "Identifier", "type": "string" }, "identifierType": { "enum": [ "URL", "INTERNAL" ], "title": "Identifier Type", "type": "string" } }, "required": [ "identifier", "identifierType" ], "title": "Schema", "type": "object" }, "schemaVersion": { "title": "Schema Version", "type": "integer" } }, "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
808eaf1e47e666e7b890b2c086c11805ac128f94
2022-02-21T09:54:48
src/main/resources/static/jsonSchemas/schemaRecordForUpdate.json
5
2024-05-28T02:23:16.441484Z
{ "$id": "http://www.example.org/schema/json", "$schema": "https://json-schema.org/draft/2019-09/schema", "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "NONE", "READ", "WRITE", "ADMINISTRATE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "comment": { "title": "Comment", "type": "string" }, "definition": { "title": "Definition", "type": "string" }, "fileSchema": { "title": "file Schema", "type": "string" }, "label": { "title": "Label", "type": "string" }, "locked": { "default": "false", "title": "Locked", "type": "boolean" }, "mimeType": { "enum": [ "application/json", "application/xml" ], "title": "mime Type", "type": "string" }, "schemaId": { "title": "Schema Record Identifier", "type": "string" }, "type": { "enum": [ "JSON", "XML" ], "title": "Type", "type": "string" } }, "required": [ "schemaId" ], "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
b7d4394b937cea77e8ce42862d29b3a3e8e9e48a
2022-03-08T07:58:33
src/main/resources/static/jsonSchemas/schemaRecordForUpdate.json
5
2024-05-28T02:23:16.441484Z
{ "$id": "http://www.example.org/schema/json", "$schema": "https://json-schema.org/draft/2019-09/schema", "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "NONE", "READ", "WRITE", "ADMINISTRATE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "comment": { "title": "Comment", "type": "string" }, "definition": { "title": "Definition", "type": "string" }, "fileSchema": { "title": "file Schema", "type": "string" }, "label": { "title": "Label", "type": "string" }, "locked": { "default": "false", "title": "Locked", "type": "boolean" }, "mimeType": { "enum": [ "application/json", "application/xml" ], "title": "mime Type", "type": "string" }, "schemaId": { "title": "Schema Record Identifier*", "type": "string" }, "type": { "enum": [ "JSON", "XML" ], "title": "Type", "type": "string" } }, "required": [ "schemaId" ], "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
2ffff8327215195ef7652384daa71bc4e33dd028
2021-11-29T15:33:43
src/main/resources/static/jsonSchemas/metadataRecord.json
5
2024-05-28T02:23:16.441484Z
{ "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "READ", "WRITE", "ADMINISTRATE", "NONE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "Sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "createdAt": { "title": "Date Created", "type": "string" }, "documentHash": { "title": "Document Hash", "type": "string" }, "id": { "title": "Identifier", "type": "string" }, "lastUpdate": { "title": "Date Updated", "type": "string" }, "metadataDocumentUri": { "title": "Metadata Document URI", "type": "string" }, "recordVersion": { "title": "Record Version", "type": "integer" }, "relatedResource": { "properties": { "identifier": { "title": "Identifier", "type": "string" }, "identifierType": { "title": "Identifier Type", "type": "string" } }, "title": "Related Resource", "type": "object" }, "schema": { "properties": { "identifier": { "title": "Identifier", "type": "string" }, "identifierType": { "enum": [ "URL" ], "title": "Identifier Type", "type": "string" } }, "title": "Schema", "type": "object" }, "schemaVersion": { "title": "Schema Version", "type": "integer" } }, "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
4ee7cef15bdad070285a27656a43f664d6c65c61
2022-04-12T10:07:26
src/main/resources/static/jsonSchemas/schemaRecordForCreate.json
5
2024-05-28T02:23:16.441484Z
{ "$id": "http://www.example.org/schema/json", "$schema": "https://json-schema.org/draft/2019-09/schema", "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "NONE", "READ", "WRITE", "ADMINISTRATE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "comment": { "title": "Comment", "type": "string" }, "definition": { "title": "Definition", "type": "string" }, "fileSchema": { "title": "Schema File", "type": "string" }, "label": { "title": "Label", "type": "string" }, "locked": { "title": "Locked", "type": "boolean" }, "mimeType": { "default": "application/json", "enum": [ "application/json", "application/xml" ], "title": "MIME Type", "type": "string" }, "schemaId": { "title": "Schema Record Identifier*", "type": "string" }, "type": { "default": "JSON", "enum": [ "JSON", "XML" ], "title": "Type", "type": "string" } }, "required": [ "schemaId" ], "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
f4986351c54fc051a56069f8cdaeda52325f59ca
2021-07-30T14:43:11
src/main/resources/static/jsonSchemas/metadataRecord.json
5
2024-05-28T02:23:16.441484Z
{ "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "READ", "WRITE", "ADMINISTRATE", "NONE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "Sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "createdAt": { "title": "Date Created", "type": "string" }, "documentHash": { "title": "Document Hash", "type": "string" }, "id": { "title": "Identifier", "type": "string" }, "lastUpdate": { "title": "Date Updated", "type": "string" }, "metadataDocumentUri": { "title": "Metadata Document URI", "type": "string" }, "recordVersion": { "title": "Record Version", "type": "integer" }, "relatedResource": { "title": "Related Resource", "type": "string" }, "schemaId": { "title": "Schema Identifier", "type": "string" }, "schemaVersion": { "title": "Schema Version", "type": "integer" } }, "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
577d91b847367dd80e02c283a3df0b82c938a1c4
2022-03-28T08:07:31
src/main/resources/static/jsonSchemas/metadataRecordForUpdate.json
5
2024-05-28T02:23:16.441484Z
{ "$id": "http://www.example.org/schema/json", "$schema": "https://json-schema.org/draft/2019-09/schema", "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "READ", "WRITE", "ADMINISTRATE", "NONE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "Sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "id": { "title": "Identifier", "type": "string" }, "metadataDocument": { "title": "Metadata Document File", "type": "string" }, "relatedResource": { "properties": { "identifier": { "title": "Identifier", "type": "string" }, "identifierType": { "title": "Identifier Type", "type": "string" } }, "title": "Related Resource", "type": "object" }, "schema": { "properties": { "identifier": { "title": "Identifier*", "type": "string" }, "identifierType": { "enum": [ "URL", "INTERNAL" ], "title": "Identifier Type*", "type": "string" } }, "required": [ "identifier", "identifierType" ], "title": "Schema", "type": "object" }, "schemaVersion": { "title": "Schema Version", "type": "integer" } }, "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
808eaf1e47e666e7b890b2c086c11805ac128f94
2022-02-21T09:54:48
src/main/resources/static/jsonSchemas/metadataRecordForCreate.json
5
2024-05-28T02:23:16.441484Z
{ "$id": "http://www.example.org/schema/json", "$schema": "https://json-schema.org/draft/2019-09/schema", "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "READ", "WRITE", "ADMINISTRATE", "NONE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "Sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "metadataDocument": { "title": "Metadata Document", "type": "string" }, "relatedResource": { "properties": { "identifier": { "title": "Identifier", "type": "string" }, "identifierType": { "default": "INTERNAL", "title": "Identifier Type", "type": "string" } }, "required": [ "identifier", "identifierType" ], "title": "Related Resource", "type": "object" }, "schema": { "properties": { "identifier": { "title": "Identifier", "type": "string" }, "identifierType": { "enum": [ "URL", "INTERNAL" ], "title": "Identifier Type", "type": "string" } }, "required": [ "identifier", "identifierType" ], "title": "Schema", "type": "object" }, "schemaVersion": { "title": "Schema Version", "type": "integer" } }, "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
808eaf1e47e666e7b890b2c086c11805ac128f94
2022-02-21T09:54:48
src/main/resources/static/jsonSchemas/schemaRecordForCreate.json
5
2024-05-28T02:23:16.441484Z
{ "$id": "http://www.example.org/schema/json", "$schema": "https://json-schema.org/draft/2019-09/schema", "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "NONE", "READ", "WRITE", "ADMINISTRATE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "comment": { "title": "Comment", "type": "string" }, "definition": { "title": "Definition", "type": "string" }, "fileSchema": { "title": "file Schema", "type": "string" }, "label": { "title": "Label", "type": "string" }, "locked": { "title": "Locked", "type": "boolean" }, "mimeType": { "default": "application/json", "enum": [ "application/json", "application/xml" ], "title": "mime Type", "type": "string" }, "schemaId": { "title": "Schema Record Identifier", "type": "string" }, "type": { "default": "JSON", "enum": [ "JSON", "XML" ], "title": "Type", "type": "string" } }, "required": [ "schemaId" ], "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
4caf23b3514c6cb5b5fcee756c65bb113593ebce
2022-01-10T11:01:42
src/main/resources/static/jsonSchemas/metadataRecordForCreate.json
5
2024-05-28T02:23:16.441484Z
{ "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "READ", "WRITE", "ADMINISTRATE", "NONE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "Sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "metadataDocument": { "title": "Metadata Document", "type": "string" }, "relatedResource": { "properties": { "identifier": { "title": "Identifier", "type": "string" }, "identifierType": { "default": "INTERNAL", "title": "Identifier Type", "type": "string" } }, "required": [ "identifier", "identifierType" ], "title": "Related Resource", "type": "object" }, "schema": { "properties": { "identifier": { "title": "Identifier", "type": "string" }, "identifierType": { "enum": [ "URL", "INTERNAL" ], "title": "Identifier Type", "type": "string" } }, "required": [ "identifier", "identifierType" ], "title": "Schema", "type": "object" }, "schemaVersion": { "title": "Schema Version", "type": "integer" } }, "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
4ee7cef15bdad070285a27656a43f664d6c65c61
2022-04-12T10:07:26
src/main/resources/static/jsonSchemas/schemaRecordForUpdate.json
5
2024-05-28T02:23:16.441484Z
{ "$id": "http://www.example.org/schema/json", "$schema": "https://json-schema.org/draft/2019-09/schema", "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "NONE", "READ", "WRITE", "ADMINISTRATE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "comment": { "title": "Comment", "type": "string" }, "definition": { "title": "Definition", "type": "string" }, "fileSchema": { "title": "Schema File", "type": "string" }, "label": { "title": "Label", "type": "string" }, "locked": { "default": "false", "title": "Locked", "type": "boolean" }, "mimeType": { "enum": [ "application/json", "application/xml" ], "title": "MIME Type", "type": "string" }, "schemaId": { "title": "Schema Record Identifier*", "type": "string" }, "type": { "enum": [ "JSON", "XML" ], "title": "Type", "type": "string" } }, "required": [ "schemaId" ], "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
4406ffb9197376533f78f35d6cc11fe35eae7ed2
2021-12-09T10:39:47
src/main/resources/static/jsonSchemas/metadataRecord.json
5
2024-05-28T02:23:16.441484Z
{ "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "READ", "WRITE", "ADMINISTRATE", "NONE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "Sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "createdAt": { "title": "Date Created", "type": "string" }, "documentHash": { "title": "Document Hash", "type": "string" }, "id": { "title": "Identifier", "type": "string" }, "lastUpdate": { "title": "Date Updated", "type": "string" }, "metadataDocumentUri": { "title": "Metadata Document URI", "type": "string" }, "recordVersion": { "title": "Record Version", "type": "integer" }, "relatedResource": { "properties": { "identifier": { "title": "Identifier", "type": "string" }, "identifierType": { "title": "Identifier Type", "type": "string" } }, "title": "Related Resource", "type": "object" }, "schema": { "properties": { "identifier": { "title": "Identifier", "type": "string" }, "identifierType": { "enum": [ "URL", "INTERNAL" ], "title": "Identifier Type", "type": "string" } }, "title": "Schema", "type": "object" }, "schemaVersion": { "title": "Schema Version", "type": "integer" } }, "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
a75959a1b583ead384fff34aae2693f18b7c0f74
2021-07-30T14:22:52
src/main/resources/static/jsonSchemas/schemaRecord.json
5
2024-05-28T02:23:16.441484Z
{ "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "READ", "ADMINISTRATE" ], "title": "Permission", "type": "string" }, "sid": { "title": "sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "comment": { "title": "Comment", "type": "string" }, "createdAt": { "title": "Date Created", "type": "string" }, "definition": { "title": "Definition", "type": "string" }, "label": { "title": "Label", "type": "string" }, "lastUpdate": { "title": "Date Updated", "type": "string" }, "locked": { "default": "false", "title": "Locked", "type": "boolean" }, "mimeType": { "default": "application/json", "enum": [ "application/json", "application/xml" ], "title": "mime Type", "type": "string" }, "schemaDocumentUri": { "title": "Schema Document Uri", "type": "string" }, "schemaHash": { "title": "Schema Hash", "type": "string" }, "schemaId": { "title": "Schema Record Identifier", "type": "string" }, "type": { "default": "JSON", "enum": [ "JSON", "XML" ], "title": "Type", "type": "string" } }, "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
86de370ff102f2307f6e98f3e487fc43b957c778
2021-10-13T10:20:52
src/main/resources/static/jsonSchemas/schemaRecord.json
5
2024-05-28T02:23:16.441484Z
{ "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "NONE", "READ", "WRITE", "ADMINISTRATE" ], "title": "Permission", "type": "string" }, "sid": { "title": "sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "comment": { "title": "Comment", "type": "string" }, "createdAt": { "title": "Date Created", "type": "string" }, "definition": { "title": "Definition", "type": "string" }, "label": { "title": "Label", "type": "string" }, "lastUpdate": { "title": "Date Updated", "type": "string" }, "locked": { "default": "false", "title": "Locked", "type": "boolean" }, "mimeType": { "default": "application/json", "enum": [ "application/json", "application/xml" ], "title": "mime Type", "type": "string" }, "schemaDocumentUri": { "title": "Schema Document Uri", "type": "string" }, "schemaHash": { "title": "Schema Hash", "type": "string" }, "schemaId": { "title": "Schema Record Identifier", "type": "string" }, "type": { "default": "JSON", "enum": [ "JSON", "XML" ], "title": "Type", "type": "string" } }, "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
b7d4394b937cea77e8ce42862d29b3a3e8e9e48a
2022-03-08T07:58:33
src/main/resources/static/jsonSchemas/schemaRecordForCreate.json
5
2024-05-28T02:23:16.441484Z
{ "$id": "http://www.example.org/schema/json", "$schema": "https://json-schema.org/draft/2019-09/schema", "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "NONE", "READ", "WRITE", "ADMINISTRATE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "comment": { "title": "Comment", "type": "string" }, "definition": { "title": "Definition", "type": "string" }, "fileSchema": { "title": "file Schema", "type": "string" }, "label": { "title": "Label", "type": "string" }, "locked": { "title": "Locked", "type": "boolean" }, "mimeType": { "default": "application/json", "enum": [ "application/json", "application/xml" ], "title": "mime Type", "type": "string" }, "schemaId": { "title": "Schema Record Identifier*", "type": "string" }, "type": { "default": "JSON", "enum": [ "JSON", "XML" ], "title": "Type", "type": "string" } }, "required": [ "schemaId" ], "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
d8edb07e48b14087cbf1493111a00490d9244309
2021-11-12T13:08:19
src/main/resources/static/jsonSchemas/schemaRecord.json
5
2024-05-28T02:23:16.441484Z
{ "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "NONE", "READ", "WRITE", "ADMINISTRATE" ], "title": "Permission", "type": "string" }, "sid": { "title": "sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "comment": { "title": "Comment", "type": "string" }, "createdAt": { "title": "Date Created", "type": "string" }, "definition": { "title": "Definition", "type": "string" }, "label": { "title": "Label", "type": "string" }, "lastUpdate": { "title": "Date Updated", "type": "string" }, "locked": { "default": "false", "title": "Locked", "type": "boolean" }, "mimeType": { "default": "application/json", "enum": [ "application/json", "application/xml" ], "title": "mime Type", "type": "string" }, "schemaDocumentUri": { "title": "Schema Document Uri", "type": "string" }, "schemaHash": { "title": "Schema Hash", "type": "string" }, "schemaId": { "title": "Schema Record Identifier", "type": "string" }, "schemaVersion": { "title": "Schema Version", "type": "string" }, "type": { "default": "JSON", "enum": [ "JSON", "XML" ], "title": "Type", "type": "string" } }, "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
86de370ff102f2307f6e98f3e487fc43b957c778
2021-10-13T10:20:52
src/main/resources/static/jsonSchemas/schemaRecordForCreate.json
5
2024-05-28T02:23:16.441484Z
{ "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "NONE", "READ", "WRITE", "ADMINISTRATE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "comment": { "title": "Comment", "type": "string" }, "definition": { "title": "Definition", "type": "string" }, "fileSchema": { "title": "file Schema", "type": "string" }, "label": { "title": "Label", "type": "string" }, "locked": { "title": "Locked", "type": "boolean" }, "mimeType": { "default": "application/json", "enum": [ "application/json", "application/xml" ], "title": "mime Type", "type": "string" }, "schemaId": { "title": "Schema Record Identifier", "type": "string" }, "type": { "default": "JSON", "enum": [ "JSON", "XML" ], "title": "Type", "type": "string" } }, "required": [ "schemaId" ], "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
808eaf1e47e666e7b890b2c086c11805ac128f94
2022-02-21T09:54:48
src/main/resources/static/jsonSchemas/schemaRecord.json
5
2024-05-28T02:23:16.441484Z
{ "$id": "http://www.example.org/schema/json", "$schema": "https://json-schema.org/draft/2019-09/schema", "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "NONE", "READ", "WRITE", "ADMINISTRATE" ], "title": "Permission", "type": "string" }, "sid": { "title": "sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "comment": { "title": "Comment", "type": "string" }, "createdAt": { "title": "Date Created", "type": "string" }, "definition": { "title": "Definition", "type": "string" }, "label": { "title": "Label", "type": "string" }, "lastUpdate": { "title": "Date Updated", "type": "string" }, "locked": { "default": "false", "title": "Locked", "type": "boolean" }, "mimeType": { "default": "application/json", "enum": [ "application/json", "application/xml" ], "title": "mime Type", "type": "string" }, "schemaDocumentUri": { "title": "Schema Document Uri", "type": "string" }, "schemaHash": { "title": "Schema Hash", "type": "string" }, "schemaId": { "title": "Schema Record Identifier", "type": "string" }, "schemaVersion": { "title": "Schema Version", "type": "string" }, "type": { "default": "JSON", "enum": [ "JSON", "XML" ], "title": "Type", "type": "string" } }, "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
a75959a1b583ead384fff34aae2693f18b7c0f74
2021-07-30T14:22:52
src/main/resources/static/jsonSchemas/schemaRecordForUpdate.json
5
2024-05-28T02:23:16.441484Z
{ "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "READ", "ADMINISTRATE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "comment": { "title": "Comment", "type": "string" }, "definition": { "title": "Definition", "type": "string" }, "fileSchema": { "title": "file Schema", "type": "string" }, "label": { "title": "Label", "type": "string" }, "locked": { "default": "false", "title": "Locked", "type": "boolean" }, "mimeType": { "enum": [ "application/json", "application/xml" ], "title": "mime Type", "type": "string" }, "schemaId": { "title": "Schema Record Identifier", "type": "string" }, "type": { "enum": [ "JSON", "XML" ], "title": "Type", "type": "string" } }, "required": [ "schemaId" ], "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
808eaf1e47e666e7b890b2c086c11805ac128f94
2022-02-21T09:54:48
src/main/resources/static/jsonSchemas/metadataRecord.json
5
2024-05-28T02:23:16.441484Z
{ "$id": "http://www.example.org/schema/json", "$schema": "https://json-schema.org/draft/2019-09/schema", "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "READ", "WRITE", "ADMINISTRATE", "NONE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "Sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "createdAt": { "title": "Date Created", "type": "string" }, "documentHash": { "title": "Document Hash", "type": "string" }, "id": { "title": "Identifier", "type": "string" }, "lastUpdate": { "title": "Date Updated", "type": "string" }, "metadataDocumentUri": { "title": "Metadata Document URI", "type": "string" }, "recordVersion": { "title": "Record Version", "type": "integer" }, "relatedResource": { "properties": { "identifier": { "title": "Identifier", "type": "string" }, "identifierType": { "title": "Identifier Type", "type": "string" } }, "title": "Related Resource", "type": "object" }, "schema": { "properties": { "identifier": { "title": "Identifier", "type": "string" }, "identifierType": { "enum": [ "URL", "INTERNAL" ], "title": "Identifier Type", "type": "string" } }, "title": "Schema", "type": "object" }, "schemaVersion": { "title": "Schema Version", "type": "integer" } }, "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
86de370ff102f2307f6e98f3e487fc43b957c778
2021-10-13T10:20:52
src/main/resources/static/jsonSchemas/metadataRecordForCreate.json
5
2024-05-28T02:23:16.441484Z
{ "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "READ", "WRITE", "ADMINISTRATE", "NONE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "Sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "relatedResource": { "properties": { "identifier": { "title": "Identifier", "type": "string" }, "identifierType": { "default": "INTERNAL", "title": "Identifier Type", "type": "string" } }, "required": [ "identifier", "identifierType" ], "title": "Related Resource", "type": "object" }, "schema": { "properties": { "identifier": { "title": "Identifier", "type": "string" }, "identifierType": { "enum": [ "INTERNAL" ], "title": "Identifier Type", "type": "string" } }, "required": [ "identifier", "identifierType" ], "title": "Schema", "type": "object" }, "schemaVersion": { "title": "Schema Version", "type": "integer" } }, "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
a75959a1b583ead384fff34aae2693f18b7c0f74
2021-07-30T14:22:52
src/main/resources/static/jsonSchemas/schemaRecordForCreate.json
5
2024-05-28T02:23:16.441484Z
{ "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "READ", "WRITE", "ADMINISTRATE", "NONE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "comment": { "title": "Comment", "type": "string" }, "definition": { "title": "Definition", "type": "string" }, "fileSchema": { "title": "file Schema", "type": "string" }, "label": { "title": "Label", "type": "string" }, "locked": { "title": "Locked", "type": "boolean" }, "mimeType": { "default": "application/json", "enum": [ "application/json", "application/xml" ], "title": "mime Type", "type": "string" }, "schemaId": { "title": "Schema Record Identifier", "type": "string" }, "type": { "default": "JSON", "enum": [ "JSON", "XML" ], "title": "Type", "type": "string" } }, "required": [ "schemaId" ], "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
f4986351c54fc051a56069f8cdaeda52325f59ca
2021-07-30T14:43:11
src/main/resources/static/jsonSchemas/metadataRecordForCreate.json
5
2024-05-28T02:23:16.441484Z
{ "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "READ", "WRITE", "ADMINISTRATE", "NONE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "Sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "id": { "title": "Identifier", "type": "string" }, "relatedResource": { "title": "Related Resource", "type": "string" }, "schemaId": { "title": "Schema Identifier", "type": "string" }, "schemaVersion": { "title": "Schema Version", "type": "integer" } }, "required": [ "schemaId", "relatedResource" ], "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
2c89264a30ceab134d03fe9ca93c847914c64683
2022-02-24T14:42:48
src/main/resources/static/jsonSchemas/metadataRecordForUpdate.json
5
2024-05-28T02:23:16.441484Z
{ "$id": "http://www.example.org/schema/json", "$schema": "https://json-schema.org/draft/2019-09/schema", "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "READ", "WRITE", "ADMINISTRATE", "NONE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "Sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "id": { "title": "Identifier", "type": "string" }, "metadataDocument": { "title": "Metadata Document File", "type": "string" }, "relatedResource": { "properties": { "identifier": { "title": "Identifier", "type": "string" }, "identifierType": { "title": "Identifier Type", "type": "string" } }, "title": "Related Resource", "type": "object" } }, "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
86de370ff102f2307f6e98f3e487fc43b957c778
2021-10-13T10:20:52
src/main/resources/static/jsonSchemas/metadataRecord.json
5
2024-05-28T02:23:16.441484Z
{ "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "READ", "WRITE", "ADMINISTRATE", "NONE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "Sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "createdAt": { "title": "Date Created", "type": "string" }, "documentHash": { "title": "Document Hash", "type": "string" }, "id": { "title": "Identifier", "type": "string" }, "lastUpdate": { "title": "Date Updated", "type": "string" }, "metadataDocumentUri": { "title": "Metadata Document URI", "type": "string" }, "recordVersion": { "title": "Record Version", "type": "integer" }, "relatedResource": { "properties": { "identifier": { "title": "Identifier", "type": "string" }, "identifierType": { "title": "Identifier Type", "type": "string" } }, "title": "Related Resource", "type": "object" }, "schema": { "properties": { "identifier": { "title": "Identifier", "type": "string" }, "identifierType": { "enum": [ "INTERNAL" ], "title": "Identifier Type", "type": "string" } }, "title": "Schema", "type": "object" }, "schemaVersion": { "title": "Schema Version", "type": "integer" } }, "type": "object" }
Apache-2.0
en
kit-data-manager/metastore2
86de370ff102f2307f6e98f3e487fc43b957c778
2021-10-13T10:20:52
src/main/resources/static/jsonSchemas/schemaRecordForUpdate.json
5
2024-05-28T02:23:16.441484Z
{ "properties": { "acl": { "items": { "properties": { "permission": { "default": "ADMINISTRATE", "enum": [ "NONE", "READ", "WRITE", "ADMINISTRATE" ], "title": "Permission", "type": "string" }, "sid": { "default": "SELF", "title": "sid", "type": "string" } }, "type": "object" }, "title": "ACL", "type": "array" }, "comment": { "title": "Comment", "type": "string" }, "definition": { "title": "Definition", "type": "string" }, "fileSchema": { "title": "file Schema", "type": "string" }, "label": { "title": "Label", "type": "string" }, "locked": { "default": "false", "title": "Locked", "type": "boolean" }, "mimeType": { "enum": [ "application/json", "application/xml" ], "title": "mime Type", "type": "string" }, "schemaId": { "title": "Schema Record Identifier", "type": "string" }, "type": { "enum": [ "JSON", "XML" ], "title": "Type", "type": "string" } }, "required": [ "schemaId" ], "type": "object" }
Apache-2.0
en