Backlog Utils

Backlog Utils is a client tool for the Backlog API.

Features

At this time we only support Wiki operations.

• List wiki pages with optional pattern.
• Rename wiki page
• Replace strings in the content of wiki page
• List wiki pages and rename them with optional pattern
• List wiki pages and replace strings in the content with optional pattern.

Commands

NAME:
   bkl - Backlog utilities

USAGE:
   bkl [global options] [command [command options]]

VERSION:
   0.0.1 (revision: 950fbaa)

DESCRIPTION:
   A cli application for Backlog utilities.

COMMANDS:
   wiki  Backlog wiki utilities

GLOBAL OPTIONS:
   --help, -h     show help
   --version, -v  print the version

Wiki subcommands

NAME:
   bkl wiki - Backlog wiki utilities

USAGE:
   bkl wiki [command [command options]] 

COMMANDS:
   list         List wiki pages with optional pattern
   rename       Rename wiki page
   replace      Replace strings in the content of wiki page
   rename-all   List wiki pages and rename them with optional pattern
   replace-all  List wiki pages and replace strings in the content with optional pattern

OPTIONS:
   --help, -h  show help

List

NAME:
   bkl wiki list - List wiki pages with optional pattern

USAGE:
   bkl wiki list

OPTIONS:
   --log-level string    set log level (default: "INFO") [$BACKLOG_LOG_LEVEL]
   --base-url string     set backlog base url [$BACKLOG_URL]
   --api-key string      set backlog api key [$BACKLOG_API_KEY]
   --project-key string  set backlog project key
   --pattern string      set pattern to search for wiki pages
   --help, -h            show help

Rename

NAME:
   bkl wiki rename - Rename wiki page

USAGE:
   bkl wiki rename [command [command options]]

OPTIONS:
   --log-level string  set log level (default: "INFO") [$BACKLOG_LOG_LEVEL]
   --base-url string   set backlog base url [$BACKLOG_URL]
   --api-key string    set backlog api key [$BACKLOG_API_KEY]
   --wiki-id int       set backlog wiki id
   --old string        set string to be replaced in wiki page
   --new string        set new string after replacement in wiki page
   --help, -h          show help

Replace

NAME:
   bkl wiki replace - Replace strings in the content of wiki page

USAGE:
   bkl wiki replace [command [command options]]

OPTIONS:
   --log-level string                 set log level (default: "INFO") [$BACKLOG_LOG_LEVEL]
   --base-url string                  set backlog base url [$BACKLOG_URL]
   --api-key string                   set backlog api key [$BACKLOG_API_KEY]
   --wiki-id int                      set backlog wiki id
   --pairs string [ --pairs string ]  set pairs of old and new repalacements for wiki page
   --help, -h                         show help

Rename All

NAME:
   bkl wiki rename-all - List wiki pages and rename them with optional pattern

USAGE:
   bkl wiki rename-all [command [command options]]

OPTIONS:
   --log-level string    set log level (default: "INFO") [$BACKLOG_LOG_LEVEL]
   --base-url string     set backlog base url [$BACKLOG_URL]
   --api-key string      set backlog api key [$BACKLOG_API_KEY]
   --project-key string  set backlog project key
   --pattern string      set pattern to search for wiki pages
   --old string          set string to be replaced in wiki page
   --new string          set new string after replacement in wiki page
   --help, -h            show help

Replace All

NAME:
   bkl wiki replace-all - List wiki pages and replace strings in the content with optional pattern

USAGE:
   bkl wiki replace-all [command [command options]]

OPTIONS:
   --log-level string                 set log level (default: "INFO") [$BACKLOG_LOG_LEVEL]
   --base-url string                  set backlog base url [$BACKLOG_URL]
   --api-key string                   set backlog api key [$BACKLOG_API_KEY]
   --project-key string               set backlog project key
   --pattern string                   set pattern to search for wiki pages
   --pairs string [ --pairs string ]  set pairs of old and new repalacements for wiki page
   --help, -h                         show help

Installation

Install with homebrew

brew install nekrassov01/tap/backlog-utils

Install with go

go install github.com/nekrassov01/backlog-utils/cmd/bkl@latest

Or download binary from releases

Prerequisites

Set the following environment variables.

export BACKLOG_URL=https://your-space.backlog.jp
export BACKLOG_API_KEY=****

Completion

Shell completion support if bash, fish, pwsh, and zsh.

source <(bkl completion bash)

Todo

• Non-Wiki implementations
• Colorized logger implementations

Author

nekrassov01

License

MIT