Skip to content

srv1054/trellgo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

trellgo

This service slurps down trello boards and cards and converts them into file system structures, with attachments, Markdown documents, etc

Preserving Trello data in a non-cloud format. You know in case they go away and I want me freakin data in a consumable format that's not a CSV, XLSX, or JSON file.

See trellgo -h for available parameters and help.

Trello API

This requires a Trello API Token and a Key, so get those first: https://developer.atlassian.com/cloud/trello/guides/rest-api/api-introduction/
These should be stored in a .env files in the same directory the binary is executed from.
Example .env

TRELLGO_APIKEY="MyAPIKey"
TRELLGO_APITOK="MyAPIToken"

File Structure

You are required to specify a top level path for where things will be saved, using -s.
Underneath that path the file structure will look like this:

/Board Name
  /List Name
    /Card Name
      /Attachments
        Downloaded attachment files (pdf, jpg, etc)
      /Checklists
        Markdown text files
      Markdown Text files with specific card data in them such as users, descriptions, history, etc
Board Background image file
Markdown Text file of Board data (Labels, Members, etc)

Additional Data retreival

You can use the -label parameter and get a prettied dump of all the Labels available on a board, in case you want to dump the board based on a specific label.
You can use the -count parameter and get a prettified card count of Open Cards, Visible Cards, and Archived (closed) Cards

Extra logging info

Right now minimal info is dumped to the console when you run the binary, by design, however if you want gobs of information to see what's going on, add -loud to the CLI paramemter list.

You can also add the parameter -log "file" and specify a file with a path to a log file. This will write all messages (info,warn,err) to this file, regardless of settings with -qq or -loud. If this file exists, the system will append to it, if it does not exist it will be created. This is off by default, you must specify -log "file" to use this feature.

Examples

  • Normal board dump with no archived cards
    • trellgo -b c52d11s -s '/path/to/here'
  • Board dump including archived cards, splitting archived cards in to their own /ARCHIVE directory
    • trellgo -b c52d11s -a -split -s '/path/to/here'
  • Dump a list of labels used on the board
    • trellgo -b t532aad -labels
  • Dump total count of cards via status
    • trellgo -b 5f3g1a2 -count
  • Dump the board but only cards with the label "Completed Items"
    • trellgo -b 5f3g1a2 -label "Completed Items" -s '/path/to/here'
  • Add logging file to a scenario
    • trellgo -b 5f3g1a2 -s '/path/to/here' -logs '/path/file.log'

Notes

Please improve and add features and fix bugs. Just submit a Pull Request for review and we will merge things in! I should have started this project using Cobra...but I didn't, so there it is. Future feature might be to move to Cobra

About

Slurp down trello boards to file systems

Resources

License

Stars

Watchers

Forks