Skip to main content

CLI tool for managing Lark Suite tasks

Project description

Boring CLI

PyPI version Python 3.9+ License: MIT

CLI tool for managing Lark Suite bug tasks from the command line.

Installation

pip install boring-cli

Quick Start Guide

Step 1: Run Setup

boring setup

Step 2: Configure Settings

You'll be prompted for the following settings:

Server URL [https://boring.omelet.tech/api]: (press Enter to use default)
Bugs output directory [/tmp/bugs]: /path/to/your/project/bugs
Tasklist GUID (from Lark) []: 9a31701d-fd0e-4417-b00d-e040afe2b234
In-progress Section GUID []: e2c8e412-fbae-41ea-9daa-c2b58efc1b87
Solved Section GUID []: 76a74fd6-79d8-4f74-a358-e78c688ee5ef

Default GUIDs for Bugs list:

Setting GUID
Tasklist GUID 9a31701d-fd0e-4417-b00d-e040afe2b234
In-progress Section (Inprogress - Bình) e2c8e412-fbae-41ea-9daa-c2b58efc1b87
Solved Section 76a74fd6-79d8-4f74-a358-e78c688ee5ef

Step 3: Login with Lark

  1. A browser window will open for Lark login
  2. Login with your Lark account
  3. After login, you'll see a JSON response like:
    {"user":{...},"token":{"access_token":"eyJhbGciOiJ...",...}}
    
  4. Copy the access_token value (the long string starting with eyJ...)
  5. Paste it in the terminal when prompted
Paste your access_token here: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Login successful!
Setup complete!

Step 4: Download Bug Tasks

Download all tasks from your configured section:

boring download

Download to a specific directory:

boring download --dir /path/to/your/project/bugs

Download from a specific section:

boring download --section e2c8e412-fbae-41ea-9daa-c2b58efc1b87

Step 5: View Sections (Optional)

List all tasklists and sections to find GUIDs:

boring sections

Commands Reference

Command Description
boring setup Configure CLI and login to Lark
boring download Download tasks to local folder
boring download --section GUID Download from specific section
boring download --dir PATH Download to specific directory
boring download --labels "Critical,High" Filter by labels
boring sections List all tasklists and sections
boring solve Move tasks to Solved section
boring solve --keep Solve but keep local folders
boring status Show current configuration
boring --version Show version
boring --help Show help

Configuration File

Configuration is stored in ~/.boring-agents/config.yaml:

server_url: https://boring.omelet.tech/api
jwt_token: eyJhbGc...
bugs_dir: /path/to/your/project/bugs
tasklist_guid: 9a31701d-fd0e-4417-b00d-e040afe2b234
section_guid: e2c8e412-fbae-41ea-9daa-c2b58efc1b87
solved_section_guid: 76a74fd6-79d8-4f74-a358-e78c688ee5ef

Troubleshooting

Token Expired

If you see authentication errors, run boring setup again to get a new token.

Find Section GUIDs

Run boring sections to list all available tasklists and their sections with GUIDs.

Requirements

  • Python 3.9+

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

boring_cli-0.1.4.tar.gz (11.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

boring_cli-0.1.4-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

Details for the file boring_cli-0.1.4.tar.gz.

File metadata

  • Download URL: boring_cli-0.1.4.tar.gz
  • Upload date:
  • Size: 11.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for boring_cli-0.1.4.tar.gz
Algorithm Hash digest
SHA256 1fd2b045669dcefb6813c3fccca837d8af3ed5fcc852ee15adaaded2f8e0a3ab
MD5 9d926334112cef67d7e61ad13303b623
BLAKE2b-256 98e1390f3f6fc63a8e0281c000ac0fd91da724860d15ab5f286f2d4f687a9844

See more details on using hashes here.

File details

Details for the file boring_cli-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: boring_cli-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 15.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for boring_cli-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8b4759b0738b4eb58e0491a242ae2d21d43812311e01b29150092a5c66357ff9
MD5 35ea1e137b752fe1d89a4fc91470754f
BLAKE2b-256 d7f708ead882709c2dfd5dcfaaa5db3ccbff60cb449df2a1e8491d081599f14a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page