This section will describe the key bindings and their associated commands.
Keybindings
| Keybindings | Interactive commands | Description |
|---|---|---|
| C-c o v | M-x org-trello-version | Display the current version installed. |
| C-c o i | M-x org-trello-install-key-and-token | Install the keys and the access-token. |
| C-c o I | M-x org-trello-install-board-metadata | Select the board and attach the todo, doing and done list. |
| C-c o u | M-x org-trello-update-board-metadata | Update the buffer’s trello board metadata. |
| C-c o b | M-x org-trello-create-board-and-install-metadata | Create interactively a board and attach the newly created trello board with the current org file. |
| C-c o d | M-x org-trello-check-setup | Check that the setup is ok. If everything is ok, will simply display ‘Setup ok!’. |
| C-c o D | M-x org-trello-delete-setup | Clean up the org buffer from all org-trello informations. |
| C-c o c | M-x org-trello-sync-card | Create/Update a complete card. |
| C-c o s | M-x org-trello-sync-buffer | Synchronize the org-mode file to the trello board (org-mode -> trello). With prefix C-u, sync-from-trello (org-mode <- trello). |
| C-c $ | M-x org-trello-archive-card | Archive current card at point. This is the standard org binding. |
| C-c o A | M-x org-trello-archive-cards | Archive all DONE cards. |
| C-c o g | M-x org-trello-abort-sync | Abort synchronization activities. |
| C-c o k | M-x org-trello-kill-entity | Kill the entity (and its arborescence tree) from the trello board and the org buffer. |
| C-c o K | M-x org-trello-kill-cards | Kill all the entities (and their arborescence tree) from the trello board and the org buffer. |
| C-c o a | M-x org-trello-assign-me | Assign oneself to the card. With C-u modifier, unassign oneself from the card. |
| C-c o C | M-x org-trello-add-card-comments | Add a comment to the card. With C-u modifier, remove the current card’s comment. |
| M-x org-trello-delete-card-comment | Delete card comment at point. | |
| C-c o l | M-x org-trello-show-board-labels | Display the board’s labels in a pop-up buffer. |
| C-c o j | M-x org-trello-jump-to-trello-card | Jump to card in browser. |
| C-c o J | M-x org-trello-jump-to-trello-board | Open the browser to your current trello board. |
| C-c o h | M-x org-trello-help-describing-bindings | This help message. |
Note:
- org-trello tries to enforce symmetry, mainly regarding the sync actions. So by default, an action pushes to trello. Using C-u, the symmetric actions pulls from trello.
- An entity in org-trello is either a card, checklist or an item.
Bindings override
You can, as usual override those proposed default bindings.
For example:
(require 'org-trello)
(add-hook 'org-trello-mode-hook
(lambda ()
(define-key org-trello-mode-map (kbd "C-c x v") 'org-trello-version)
(define-key org-trello-mode-map (kbd "C-c x i") 'org-trello-install-key-and-token)
(define-key org-trello-mode-map (kbd "C-c x I") 'org-trello-install-board-metadata)
(define-key org-trello-mode-map (kbd "C-c x c") 'org-trello-sync-card)
(define-key org-trello-mode-map (kbd "C-c x s") 'org-trello-sync-buffer)
(define-key org-trello-mode-map (kbd "C-c x a") 'org-trello-assign-me)
(define-key org-trello-mode-map (kbd "C-c x d") 'org-trello-check-setup)
(define-key org-trello-mode-map (kbd "C-c x D") 'org-trello-delete-setup)
(define-key org-trello-mode-map (kbd "C-c x b") 'org-trello-create-board-and-install-metadata)
(define-key org-trello-mode-map (kbd "C-c x k") 'org-trello-kill-entity)
(define-key org-trello-mode-map (kbd "C-c x K") 'org-trello-kill-cards)
(define-key org-trello-mode-map (kbd "C-c x a") 'org-trello-archive-card)
(define-key org-trello-mode-map (kbd "C-c x A") 'org-trello-archive-cards)
(define-key org-trello-mode-map (kbd "C-c x j") 'org-trello-jump-to-trello-card)
(define-key org-trello-mode-map (kbd "C-c x J") 'org-trello-jump-to-trello-board)
(define-key org-trello-mode-map (kbd "C-c x C") 'org-trello-add-card-comments)
(define-key org-trello-mode-map (kbd "C-c x o") 'org-trello-show-card-comments)
(define-key org-trello-mode-map (kbd "C-c x l") 'org-trello-show-card-labels)
(define-key org-trello-mode-map (kbd "C-c x u") 'org-trello-update-board-metadata)
(define-key org-trello-mode-map (kbd "C-c x h") 'org-trello-help-describing-bindings)))
Note This will not update the help message with your current redefinition nor remove default bindings (you will need to do the cleanup yourself).
Prefix binding override
You can also simply change the default prefix key C-c o and let org-trello do the rest.
For this, you can customize the variable org-trello-current-prefix-keybinding:
(require 'org-trello)
(custom-set-variables '(org-trello-current-prefix-keybinding "<prefix-key>"))
For example, installing using the C-c x as prefix key:
(require 'org-trello)
(custom-set-variables '(org-trello-current-prefix-keybinding "C-c x"))
Note If org-trello was already running, you will need to relaunch the mode (M-x org-trello-mode twice).
For example, here is my startup file.