diff options
Diffstat (limited to 'clab.md')
-rw-r--r-- | clab.md | 74 |
1 files changed, 74 insertions, 0 deletions
@@ -0,0 +1,74 @@ +# Introduction + +`clab` is a command line address book application. It has no +interactive features. This document collects its acceptance criteria. + +# Empty database + +~~~scenario +given an installed clab +when I run clab lint +then command is successful + +when I run clab search Alice +then command is successful +then stdout is exactly "" +~~~ + +# Alice and Bob + +Next, let's add records for Alice and Bob, and make +sure searches find only the right records. + + +~~~scenario +given an installed clab + +given file .local/share/clab/address-book.yaml from address-book.yaml + +when I run clab lint +then command is successful + +when I run clab list +then command is successful +then stdout is valid YAML +then stdout contains "Alice Atherthon" +then stdout contains "Bob Bobbington" + +when I run clab search Alice +then command is successful +then stdout is valid YAML +then stdout contains "Alice Atherthon" +then stdout doesn't contain "Bob" + +when I run clab mutt-query Alice +then command is successful +then stdout contains "Alice Atherthon" +then stdout contains "alice@example.com" +then stdout doesn't contain "Bob" +then stdout doesn't contain "bob@example.com" +~~~ + +~~~{#address-book.yaml .file .yaml} +- name: Alice Atherthon + email: + work: alice@example.com +- name: Bob Bobbington + email: + personal: bob@example.com +~~~ + + +--- +title: "clab; – command line address book" +author: Lars Wirzenius +template: python +bindings: +- subplot/clab.yaml +- subplot/vendor/files.yaml +- subplot/vendor/runcmd.yaml +functions: +- subplot/clab.py +- subplot/vendor/files.py +- subplot/vendor/runcmd.py +... |