From b729fdedcaa681bfd417d3dbb25ead8c87375a52 Mon Sep 17 00:00:00 2001 From: MaysWind Date: Wed, 4 Mar 2026 22:37:55 +0800 Subject: [PATCH] update the command description --- scripts/ebktools.ps1 | 30 +++++++++++++++--------------- scripts/ebktools.sh | 32 ++++++++++++++++---------------- 2 files changed, 31 insertions(+), 31 deletions(-) diff --git a/scripts/ebktools.ps1 b/scripts/ebktools.ps1 index 179f81e4..af64e38b 100755 --- a/scripts/ebktools.ps1 +++ b/scripts/ebktools.ps1 @@ -27,7 +27,7 @@ $script:EBKTOOL_TOKEN = $env:EBKTOOL_TOKEN $API_CONFIGS = @( @{ Name = "tokens-list" - Description = "Get available sessions information" + Description = "Retrieve all sessions for the current user" Method = "GET" Path = "tokens/list.json" RequiresTimezone = $false @@ -53,7 +53,7 @@ $API_CONFIGS = @( } @{ Name = "tokens-revoke" - Description = "Revoke token" + Description = "Revoke a specified token" Method = "POST" Path = "tokens/revoke.json" RequiresTimezone = $false @@ -71,7 +71,7 @@ $API_CONFIGS = @( } @{ Name = "accounts-list" - Description = "Get all accounts list" + Description = "Retrieve all account information" Method = "GET" Path = "accounts/list.json" RequiresTimezone = $false @@ -109,7 +109,7 @@ $API_CONFIGS = @( } @{ Name = "accounts-add" - Description = "Add account" + Description = "Add a new account" Method = "POST" Path = "accounts/add.json" RequiresTimezone = $true @@ -162,7 +162,7 @@ $API_CONFIGS = @( } @{ Name = "transaction-categories-list" - Description = "Get all transaction categories" + Description = "Retrieve all available transaction categories" Method = "GET" Path = "transaction/categories/list.json" RequiresTimezone = $false @@ -196,7 +196,7 @@ $API_CONFIGS = @( } @{ Name = "transaction-categories-add" - Description = "Add transaction category" + Description = "Add a new transaction category" Method = "POST" Path = "transaction/categories/add.json" RequiresTimezone = $false @@ -235,7 +235,7 @@ $API_CONFIGS = @( } @{ Name = "transaction-tags-list" - Description = "Get all transaction tags list" + Description = "Retrieve all available transaction tags" Method = "GET" Path = "transaction/tags/list.json" RequiresTimezone = $false @@ -261,7 +261,7 @@ $API_CONFIGS = @( } @{ Name = "transaction-tags-add" - Description = "Add transaction tag" + Description = "Add a new transaction tag" Method = "POST" Path = "transaction/tags/add.json" RequiresTimezone = $false @@ -287,7 +287,7 @@ $API_CONFIGS = @( } @{ Name = "transactions-list" - Description = "Get transactions list with pagination" + Description = "Retrieve transaction data based on specified query criteria (with pagination support)" Method = "GET" Path = "transactions/list.json" RequiresTimezone = $true @@ -369,7 +369,7 @@ $API_CONFIGS = @( } @{ Name = "transactions-list-all" - Description = "Get all transactions list" + Description = "Retrieve all transaction data matching the specified query criteria" Method = "GET" Path = "transactions/list/all.json" RequiresTimezone = $true @@ -436,7 +436,7 @@ $API_CONFIGS = @( } @{ Name = "transactions-add" - Description = "Add transaction" + Description = "Add a new transaction" Method = "POST" Path = "transactions/add.json" RequiresTimezone = $true @@ -499,7 +499,7 @@ $API_CONFIGS = @( } @{ Name = "exchangerates-latest" - Description = "Get latest exchange rates" + Description = "Retrieve the latest exchange rate data" Method = "GET" Path = "exchange_rates/latest.json" RequiresTimezone = $false @@ -534,7 +534,7 @@ $API_CONFIGS = @( } @{ Name = "server-version" - Description = "Get ezBookkeeping server version information" + Description = "Retrieve ezBookkeeping server version information" Method = "GET" Path = "systems/version.json" RequiresTimezone = $false @@ -1169,7 +1169,7 @@ function Show-Help { Write-Host " EBKTOOL_SERVER_BASEURL ezBookkeeping server base URL (e.g., http://localhost:8080)" Write-Host " EBKTOOL_TOKEN ezBookkeeping API token" Write-Host "" - Write-Host " You can also set the above environment variables in a .env file located in the current directory, parent directory or home directory." + Write-Host " You can also set the above environment variables in a '.env' file located in the current directory, parent directory or home directory." Write-Host "" Write-Host "Global Options:" Write-Host " -tzName The IANA timezone name of current timezone. For example, for Beijing Time it is 'Asia/Shanghai'." @@ -1212,7 +1212,7 @@ function Show-CommandList { } Write-Host "" - Write-Host "Use 'ebktools.ps1 help ' to see detailed information about a API command." + Write-Host "Use 'ebktools.ps1 help ' to see detailed information about an API command." } function Show-CommandHelp { diff --git a/scripts/ebktools.sh b/scripts/ebktools.sh index de20de19..5105abd1 100755 --- a/scripts/ebktools.sh +++ b/scripts/ebktools.sh @@ -7,7 +7,7 @@ API_CONFIGS='[ { "Name": "tokens-list", - "Description": "Get available sessions information", + "Description": "Retrieve all sessions for the current user", "Method": "GET", "Path": "tokens/list.json", "RequiresTimezone": false, @@ -33,7 +33,7 @@ API_CONFIGS='[ }, { "Name": "tokens-revoke", - "Description": "Revoke token", + "Description": "Revoke a specified token", "Method": "POST", "Path": "tokens/revoke.json", "RequiresTimezone": false, @@ -51,7 +51,7 @@ API_CONFIGS='[ }, { "Name": "accounts-list", - "Description": "Get all accounts list", + "Description": "Retrieve all account information", "Method": "GET", "Path": "accounts/list.json", "RequiresTimezone": false, @@ -89,7 +89,7 @@ API_CONFIGS='[ }, { "Name": "accounts-add", - "Description": "Add account", + "Description": "Add a new account", "Method": "POST", "Path": "accounts/add.json", "RequiresTimezone": true, @@ -142,7 +142,7 @@ API_CONFIGS='[ }, { "Name": "transaction-categories-list", - "Description": "Get all transaction categories", + "Description": "Retrieve all available transaction categories", "Method": "GET", "Path": "transaction/categories/list.json", "RequiresTimezone": false, @@ -176,7 +176,7 @@ API_CONFIGS='[ }, { "Name": "transaction-categories-add", - "Description": "Add transaction category", + "Description": "Add a new transaction category", "Method": "POST", "Path": "transaction/categories/add.json", "RequiresTimezone": false, @@ -215,7 +215,7 @@ API_CONFIGS='[ }, { "Name": "transaction-tags-list", - "Description": "Get all transaction tags list", + "Description": "Retrieve all available transaction tags", "Method": "GET", "Path": "transaction/tags/list.json", "RequiresTimezone": false, @@ -241,7 +241,7 @@ API_CONFIGS='[ }, { "Name": "transaction-tags-add", - "Description": "Add transaction tag", + "Description": "Add a new transaction tag", "Method": "POST", "Path": "transaction/tags/add.json", "RequiresTimezone": false, @@ -267,7 +267,7 @@ API_CONFIGS='[ }, { "Name": "transactions-list", - "Description": "Get transactions list with pagination", + "Description": "Retrieve transaction data based on specified query criteria (with pagination support)", "Method": "GET", "Path": "transactions/list.json", "RequiresTimezone": true, @@ -349,7 +349,7 @@ API_CONFIGS='[ }, { "Name": "transactions-list-all", - "Description": "Get all transactions list", + "Description": "Retrieve all transaction data matching the specified query criteria", "Method": "GET", "Path": "transactions/list/all.json", "RequiresTimezone": true, @@ -416,7 +416,7 @@ API_CONFIGS='[ }, { "Name": "transactions-add", - "Description": "Add transaction", + "Description": "Add a new transaction", "Method": "POST", "Path": "transactions/add.json", "RequiresTimezone": true, @@ -479,7 +479,7 @@ API_CONFIGS='[ }, { "Name": "exchangerates-latest", - "Description": "Get latest exchange rates", + "Description": "Retrieve the latest exchange rate data", "Method": "GET", "Path": "exchange_rates/latest.json", "RequiresTimezone": false, @@ -514,7 +514,7 @@ API_CONFIGS='[ }, { "Name": "server-version", - "Description": "Get ezBookkeeping server version information", + "Description": "Retrieve ezBookkeeping server version information", "Method": "GET", "Path": "systems/version.json", "RequiresTimezone": false, @@ -817,7 +817,7 @@ Environment Variables (Required): EBKTOOL_SERVER_BASEURL ezBookkeeping server base URL (e.g., http://localhost:8080) EBKTOOL_TOKEN ezBookkeeping API token - You can also set the above environment variables in a .env file located in the current directory, parent directory or home directory. + You can also set the above environment variables in a '.env' file located in the current directory, parent directory or home directory. Global Options: --tz-name The IANA timezone name of current timezone. For example, for Beijing Time it is 'Asia/Shanghai'. @@ -860,7 +860,7 @@ list_commands() { done echo "" - echo "Use 'ebktools.sh help ' to see detailed information about a API command." + echo "Use 'ebktools.sh help ' to see detailed information about an API command." } show_command_help() { @@ -1000,7 +1000,7 @@ call_api() { case "$param_type" in integer) if ! echo "$param_value" | grep -Eq '^-?[0-9]+$'; then - echo_red "Error: Parameter '--${param_name}' must be a integer value" + echo_red "Error: Parameter '--${param_name}' must be an integer value" exit 1 fi ;;