https://github.com/kvch/wfw
command-line interface for Workflowy
https://github.com/kvch/wfw
cli python workflowy
Last synced: 2 months ago
JSON representation
command-line interface for Workflowy
- Host: GitHub
- URL: https://github.com/kvch/wfw
- Owner: kvch
- License: gpl-3.0
- Created: 2015-02-15T00:00:09.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-03-12T00:19:27.000Z (over 8 years ago)
- Last Synced: 2025-03-28T21:02:20.000Z (3 months ago)
- Topics: cli, python, workflowy
- Language: Python
- Size: 50.8 KB
- Stars: 33
- Watchers: 7
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
WFW
===
CLI for WorkFlowy inspired by WWW:WorkFlowy_
WorkFlowy does not maintain an external API, so the cli can break anytime. **Do not use it for anything mission critical.**
Installation
------------
Please note that the package supports **Python 2.7** only.
Install it using pip
::
pip install wfw
Configuration
-------------
Configure the tool using a configuration file. The name of the file have to be .wfwrc and it is must be located
in the home directory. **If the following options are not set properly, connecting to the server is not possible.**
Sample configuration
~~~~~~~~~~~~~~~~~~~~
/home/user/.wfwrc
::
[user]
email: [email protected]
password: secretpass
Commands
--------
wfw add
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Add new item to list.
| parent-item: parent of the new item
| new-item: new item's text
``wfw add "My list" "Shopping list"``
``wfw add places home``
wfw agenda
~~~~~~~~~~~~~~
Agenda view of a node's children.
item: root of the agenda
``wfw agenda ThisWeek``
wfw export
~~~~~~~~~~~~~~~~~~~~~
Export the list to file. The output file can be imported to hnb.
filename: path to file, default: tree.exported in current directory
``wfw export``
``wfw export my-pretty-file``
wfw fetch
~~~~~~~~~
Fetch list from WorkFlowy server.
``wfw fetch``
wfw find
~~~~~~~~~~~~~~~~~~
Find items using pattern matching.
pattern: pattern that matches the item
``wfw find TODO``
``wfw find ba*``
wfw info
~~~~~~~~~~~~~~~
Show statistics based on the items state.
``wfw info tasks``
item: root of the group of tasks
wfw rm
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Remove item from list.
| parent-item: parent of the deleted item
| deleted-item: deleted item's text
``wfw rm "My list" TODOs``
``wfw rm TODO shopping``
wfw show --root
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Prints list until given depth.
| root: text of the root item, default: root of tree
| depth: height of tree to be printed, default: 1
``wfw show``
``wfw show 2``
``wfw show --root personal 3``
wfw tag
~~~~~~~~~~~~~~~~~~~~~
Find items containing the given tag.
tag-to-find: name of tag to find
``wfw tag @work``
``wfw tag "#ThisWeek"``
Author
======
Noemi Vanyi
.. _WWW:WorkFlowy: https://github.com/cotto/www-workflowy/