Skip to content

todarch/todarch-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

57 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Todarch CLI

Command line utility to interact with the Todarch application.

Install

You can download the single executable on releases.

# download
# mkdir $TODARCH_HOME as $HOME/.todarch
# extract to $TODARCH_HOME
# rename if you wish
mv $TODARCH_HOME/todarch-cli $TODARCH_HOME/td
# add $TODARCH_HOME to your $PATH
# create your own configuration as explain in the section
# finally
td version

You may use the installation script as well, it will do all for you.

curl -s "https://raw.githubusercontent.com/todarch/todarch-cli/master/install" | bash

Configuration

The application expects to read a config file at $HOME/.todarch/config.yml location.

todarchApiBase: https://api.todarch.com

Commands

You need a Todarch account to use the cli application. You can create one on todarch.com.

td check
td help
  • Create todos
td create
td create --interactive
td create --editor
td create --file yourtododefinition.yml
  • List your todos
# shows todos with INITIAL status
td todo ls

# show todos with any status
td todo ls -a

td todo ls -l
  • See the details of your todo
td todo inspect $ID
td todo inspect $ID --output yml
  • Get your todo done
td todo done $ID
  • Delete your todos
td todo rm $ID
  • Filter your todos using rsql
td todo ls --rsql priority=gt=5
td todo ls --rsql priority=lt=5

td todo ls --rsql timeNeededInMin=lt=60

# why do think the following form will not work as expected?
td todo ls --rsql priority>5
td todo ls --rsql priority<5

Development & Usage

If you already have golang environment setup, you can have your own build.

go get github.com/todarch/todarch-cli
cd $GOPATH/src/github.com/todarch/todarch-cli
go build -o $GOPATH/bin/td
td help