enbas/schema/enbas_cli_schema.json

145 lines
4.2 KiB
JSON

{
"flags": {
"account-name": {
"type": "string",
"description": "The name of the account"
},
"full": {
"type": "bool",
"description": "Set to true to print the build information in full"
},
"instance": {
"type": "string",
"description": "The instance that you want to log into"
},
"notify": {
"type": "bool",
"description": "Get notifications from statuses from the account you want to follow"
},
"show-reposts": {
"type": "bool",
"description": "Show reposts from the account you want to follow"
},
"type": {
"type": "string",
"description": "The type of resource you want to action on (e.g. account, status)"
},
"to": {
"type": "string",
"description": "TBC"
}
},
"commands": {
"accept": {
"additionalFields": [],
"flags": [
{ "flag": "account-name", "default": "" },
{ "flag": "type", "fieldName": "resourceType", "default": "" }
],
"summary": "Accepts a request (e.g. a follow request)",
"useConfig": true,
"usePrinter": true
},
"block": {
"additionalFields": [],
"flags": [
{ "flag": "account-name", "default": "" },
{ "flag": "type", "fieldName": "resourceType", "default": "" }
],
"summary": "Blocks a resource (e.g. an account)",
"useConfig": true,
"usePrinter": true
},
"follow": {
"additionalFields": [],
"flags": [
{ "flag": "account-name", "default": "" },
{ "flag": "notify", "default": "false" },
{ "flag": "show-reposts", "default": "true" },
{ "flag": "type", "fieldName": "resourceType", "default": "" }
],
"summary": "Follow a resource (e.g. an account)",
"useConfig": true,
"usePrinter": true
},
"init": {
"additionalFields": [
{ "name": "configDir", "type": "string"}
],
"flags": [],
"summary": "Creates a new configuration file in the specified configuration directory",
"useConfig": false,
"usePrinter": true
},
"login": {
"additionalFields": [],
"flags": [
{ "flag": "instance", "default": "" }
],
"summary": "Logs into an account on GoToSocial",
"useConfig": true,
"usePrinter": true
},
"reject": {
"additionalFields": [],
"flags": [
{ "flag": "account-name", "default": "" },
{ "flag": "type", "fieldName": "resourceType", "default": "" }
],
"summary": "Rejects a request (e.g. a follow request)",
"useConfig": true,
"usePrinter": true
},
"switch": {
"additionalFields": [],
"flags": [
{ "flag": "account-name", "default": "" },
{ "flag": "to", "default": "" }
],
"summary": "Performs a switch operation (e.g. switching between logged in accounts)",
"useConfig": true,
"usePrinter": true
},
"unblock": {
"additionalFields": [],
"flags": [
{ "flag": "account-name", "default": "" },
{ "flag": "type", "fieldName": "resourceType", "default": "" }
],
"summary": "Unblocks a resource (e.g. an account)",
"useConfig": true,
"usePrinter": true
},
"unfollow": {
"additionalFields": [],
"flags": [
{ "flag": "account-name", "default": "" },
{ "flag": "type", "fieldName": "resourceType", "default": "" }
],
"summary": "Unfollow a resource (e.g. an account)",
"useConfig": true,
"usePrinter": true
},
"version": {
"additionalFields": [
{ "name": "binaryVersion", "type": "string"},
{ "name": "buildTime", "type": "string"},
{ "name": "goVersion", "type": "string"},
{ "name": "gitCommit", "type": "string"}
],
"flags": [
{ "flag": "full", "default": "false" }
],
"summary": "Prints the application's version and build information",
"useConfig": false,
"usePrinter": true
},
"whoami": {
"flags": [],
"summary": "Prints the account that you are currently logged into",
"useConfig": true,
"usePrinter": true
}
}
}