Metadata-Version: 2.4
Name: tklr-dgraham
Version: 1.0.25
Summary: Reminders Tickler / CLI and Textual UI
Author-email: Daniel Graham <dnlgrhm@gmail.com>
License: This project is licensed under the GNU General Public License v3.0 or later.
        
        -----------------------------------------------------------------------
        
                            GNU GENERAL PUBLIC LICENSE
                               Version 3, 29 June 2007
        
         Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
         Everyone is permitted to copy and distribute verbatim copies
         of this license document, but changing it is not allowed.
        
                                    Preamble
        
          The GNU General Public License is a free, copyleft license for
        software and other kinds of works.
        
          The licenses for most software and other practical works are designed
        to take away your freedom to share and change the works.  By contrast,
        the GNU General Public License is intended to guarantee your freedom to
        share and change all versions of a program--to make sure it remains free
        software for all its users.  We, the Free Software Foundation, use the
        GNU General Public License for most of our software; it applies also to
        any other work released this way by its authors.  You can apply it to
        your programs, too.
        
          When we speak of free software, we are referring to freedom, not
        price.  Our General Public Licenses are designed to make sure that you
        have the freedom to distribute copies of free software (and charge for
        them if you wish), that you receive source code or can get it if you
        want it, that you can change the software or use pieces of it in new
        free programs, and that you know you can do these things.
        
          To protect your rights, we need to prevent others from denying you
        these rights or asking you to surrender the rights.  Therefore, you have
        certain responsibilities if you distribute copies of the software, or if
        you modify it: responsibilities to respect the freedom of others.
        
          For example, if you distribute copies of such a program, whether
        gratis or for a fee, you must pass on to the recipients the same
        freedoms that you received.  You must make sure that they, too, receive
        or can get the source code.  And you must show them these terms so they
        know their rights.
        
          Developers that use the GNU GPL protect your rights with two steps:
        (1) assert copyright on the software, and (2) offer you this License
        giving you legal permission to copy, distribute and/or modify it.
        
          For the developers' and authors' protection, the GPL clearly explains
        that there is no warranty for this free software.  For both users' and
        authors' sake, the GPL requires that modified versions be marked as
        changed, so that their problems will not be attributed erroneously to
        authors of previous versions.
        
          Some devices are designed to deny users access to install or run
        modified versions of the software inside them, although the manufacturer
        can do so.  This is fundamentally incompatible with the aim of
        protecting users' freedom to change the software.  The systematic
        pattern of such abuse occurs in the area of products for individuals to
        use, which is precisely where it is most unacceptable.  Therefore, we
        have designed this version of the GPL to prohibit the practice for those
        products.  If such problems arise substantially in other domains, we
        stand ready to extend this provision to those domains in future versions
        of the GPL, as needed to protect the freedom of users.
        
          Finally, every program is threatened constantly by software patents.
        States should not allow patents to restrict development and use of
        software on general-purpose computers, but in those that do, we wish to
        avoid the special danger that patents applied to a free program could
        make it effectively proprietary.  To prevent this, the GPL assures that
        patents cannot be used to render the program non-free.
        
          The precise terms and conditions for copying, distribution and
        modification follow.
        
                               TERMS AND CONDITIONS
        
          0. Definitions.
        
          "This License" refers to version 3 of the GNU General Public License.
        
          "Copyright" also means copyright-like laws that apply to other kinds of
        works, such as semiconductor masks.
        
          "The Program" refers to any copyrightable work licensed under this
        License.  Each licensee is addressed as "you".  "Licensees" and
        "recipients" may be individuals or organizations.
        
          To "modify" a work means to copy from or adapt all or part of the work
        in a fashion requiring copyright permission, other than the making of an
        exact copy.  The resulting work is called a "modified version" of the
        earlier work or a work "based on" the earlier work.
        
          A "covered work" means either the unmodified Program or a work based
        on the Program.
        
          To "propagate" a work means to do anything with it that, without
        permission, would make you directly or secondarily liable for
        infringement under applicable copyright law, except executing it on a
        computer or modifying a private copy.  Propagation includes copying,
        distribution (with or without modification), making available to the
        public, and in some countries other activities as well.
        
          To "convey" a work means any kind of propagation that enables other
        parties to make or receive copies.  Mere interaction with a user through
        a computer network, with no transfer of a copy, is not conveying.
        
          An interactive user interface displays "Appropriate Legal Notices"
        to the extent that it includes a convenient and prominently visible
        feature that (1) displays an appropriate copyright notice, and (2)
        tells the user that there is no warranty for the work (except to the
        extent that warranties are provided), that licensees may convey the
        work under this License, and how to view a copy of this License.  If
        the interface presents a list of user commands or options, such as a
        menu, a prominent item in the list meets this criterion.
        
          1. Source Code.
        
          The "source code" for a work means the preferred form of the work
        for making modifications to it.  "Object code" means any non-source
        form of a work.
        
          A "Standard Interface" means an interface that either is an official
        standard defined by a recognized standards body, or, in the case of
        interfaces specified for a particular programming language, one that
        is widely used among developers working in that language.
        
          The "System Libraries" of an executable work include anything, other
        than the work as a whole, that (a) is included in the normal form of
        packaging a Major Component, but which is not part of that Major
        Component, and (b) serves only to enable use of the work with that
        Major Component, or to implement a Standard Interface for which an
        implementation is available to the public in source code form.  A
        "Major Component", in this context, means a major essential component
        (kernel, window system, and so on) of the specific operating system
        (if any) on which the executable work runs, or a compiler used to
        produce the work, or an object code interpreter used to run it.
        
          The "Corresponding Source" for a work in object code form means all
        the source code needed to generate, install, and (for an executable
        work) run the object code and to modify the work, including scripts to
        control those activities.  However, it does not include the work's
        System Libraries, or general-purpose tools or generally available free
        programs which are used unmodified in performing those activities but
        which are not part of the work.  For example, Corresponding Source
        includes interface definition files associated with source files for
        the work, and the source code for shared libraries and dynamically
        linked subprograms that the work is specifically designed to require,
        such as by intimate data communication or control flow between those
        subprograms and other parts of the work.
        
          The Corresponding Source need not include anything that users
        can regenerate automatically from other parts of the Corresponding
        Source.
        
          The Corresponding Source for a work in source code form is that
        same work.
        
          2. Basic Permissions.
        
          All rights granted under this License are granted for the term of
        copyright on the Program, and are irrevocable provided the stated
        conditions are met.  This License explicitly affirms your unlimited
        permission to run the unmodified Program.  The output from running a
        covered work is covered by this License only if the output, given its
        content, constitutes a covered work.  This License acknowledges your
        rights of fair use or other equivalent, as provided by copyright law.
        
          You may make, run and propagate covered works that you do not
        convey, without conditions so long as your license otherwise remains
        in force.  You may convey covered works to others for the sole purpose
        of having them make modifications exclusively for you, or provide you
        with facilities for running those works, provided that you comply with
        the terms of this License in conveying all material for which you do
        not control copyright.  Those thus making or running the covered works
        for you must do so exclusively on your behalf, under your direction
        and control, on terms that prohibit them from making any copies of
        your copyrighted material outside their relationship with you.
        
          Conveying under any other circumstances is permitted solely under
        the conditions stated below.  Sublicensing is not allowed; section 10
        makes it unnecessary.
        
          3. Protecting Users' Legal Rights From Anti-Circumvention Law.
        
          No covered work shall be deemed part of an effective technological
        measure under any applicable law fulfilling obligations under article
        11 of the WIPO copyright treaty adopted on 20 December 1996, or
        similar laws prohibiting or restricting circumvention of such
        measures.
        
          When you convey a covered work, you waive any legal power to forbid
        circumvention of technological measures to the extent such circumvention
        is effected by exercising rights under this License with respect to
        the covered work, and you disclaim any intention to limit operation or
        modification of the work as a means of enforcing, against the work's
        users, your or third parties' legal rights to forbid circumvention of
        technological measures.
        
          4. Conveying Verbatim Copies.
        
          You may convey verbatim copies of the Program's source code as you
        receive it, in any medium, provided that you conspicuously and
        appropriately publish on each copy an appropriate copyright notice;
        keep intact all notices stating that this License and any
        non-permissive terms added in accord with section 7 apply to the code;
        keep intact all notices of the absence of any warranty; and give all
        recipients a copy of this License along with the Program.
        
          You may charge any price or no price for each copy that you convey,
        and you may offer support or warranty protection for a fee.
        
          5. Conveying Modified Source Versions.
        
          You may convey a work based on the Program, or the modifications to
        produce it from the Program, in the form of source code under the
        terms of section 4, provided that you also meet all of these conditions:
        
            a) The work must carry prominent notices stating that you modified
            it, and giving a relevant date.
        
            b) The work must carry prominent notices stating that it is
            released under this License and any conditions added under section
            7.  This requirement modifies the requirement in section 4 to
            "keep intact all notices".
        
            c) You must license the entire work, as a whole, under this
            License to anyone who comes into possession of a copy.  This
            License will therefore apply, along with any applicable section 7
            additional terms, to the whole of the work, and all its parts,
            regardless of how they are packaged.  This License gives no
            permission to license the work in any other way, but it does not
            invalidate such permission if you have separately received it.
        
            d) If the work has interactive user interfaces, each must display
            Appropriate Legal Notices; however, if the Program has interactive
            interfaces that do not display Appropriate Legal Notices, your
            work need not make them do so.
        
          A compilation of a covered work with other separate and independent
        works, which are not by their nature extensions of the covered work,
        and which are not combined with it such as to form a larger program,
        in or on a volume of a storage or distribution medium, is called an
        "aggregate" if the compilation and its resulting copyright are not
        used to limit the access or legal rights of the compilation's users
        beyond what the individual works permit.  Inclusion of a covered work
        in an aggregate does not cause this License to apply to the other
        parts of the aggregate.
        
          6. Conveying Non-Source Forms.
        
          You may convey a covered work in object code form under the terms
        of sections 4 and 5, provided that you also convey the
        machine-readable Corresponding Source under the terms of this License,
        in one of these ways:
        
            a) Convey the object code in, or embodied in, a physical product
            (including a physical distribution medium), accompanied by the
            Corresponding Source fixed on a durable physical medium
            customarily used for software interchange.
        
            b) Convey the object code in, or embodied in, a physical product
            (including a physical distribution medium), accompanied by a
            written offer, valid for at least three years and valid for as
            long as you offer spare parts or customer support for that product
            model, to give anyone who possesses the object code either (1) a
            copy of the Corresponding Source for all the software in the
            product that is covered by this License, on a durable physical
            medium customarily used for software interchange, for a price no
            more than your reasonable cost of physically performing this
            conveying of source, or (2) access to copy the
            Corresponding Source from a network server at no charge.
        
            c) Convey individual copies of the object code with a copy of the
            written offer to provide the Corresponding Source.  This
            alternative is allowed only occasionally and noncommercially, and
            only if you received the object code with such an offer, in accord
            with subsection 6b.
        
            d) Convey the object code by offering access from a designated
            place (gratis or for a charge), and offer equivalent access to the
            Corresponding Source in the same way through the same place at no
            further charge.  You need not require recipients to copy the
            Corresponding Source along with the object code.  If the place to
            copy the object code is a network server, the Corresponding Source
            may be on a different server (operated by you or a third party)
            that supports equivalent copying facilities, provided you maintain
            clear directions next to the object code saying where to find the
            Corresponding Source.  Regardless of what server hosts the
            Corresponding Source, you remain obligated to ensure that it is
            available for as long as needed to satisfy these requirements.
        
            e) Convey the object code using peer-to-peer transmission, provided
            you inform other peers where the object code and Corresponding
            Source of the work are being offered to the general public at no
            charge under subsection 6d.
        
          A separable portion of the object code, whose source code is excluded
        from the Corresponding Source as a System Library, need not be
        included in conveying the object code work.
        
          A "User Product" is either (1) a "consumer product", which means any
        tangible personal property which is normally used for personal, family,
        or household purposes, or (2) anything designed or sold for incorporation
        into a dwelling.  In determining whether a product is a consumer product,
        doubtful cases shall be resolved in favor of coverage.  For a particular
        product received by a particular user, "normally used" refers to a
        typical or common use of that class of product, regardless of the status
        of the particular user or of the way in which the particular user
        actually uses, or expects or is expected to use, the product.  A product
        is a consumer product regardless of whether the product has substantial
        commercial, industrial or non-consumer uses, unless such uses represent
        the only significant mode of use of the product.
        
          "Installation Information" for a User Product means any methods,
        procedures, authorization keys, or other information required to install
        and execute modified versions of a covered work in that User Product from
        a modified version of its Corresponding Source.  The information must
        suffice to ensure that the continued functioning of the modified object
        code is in no case prevented or interfered with solely because
        modification has been made.
        
          If you convey an object code work under this section in, or with, or
        specifically for use in, a User Product, and the conveying occurs as
        part of a transaction in which the right of possession and use of the
        User Product is transferred to the recipient in perpetuity or for a
        fixed term (regardless of how the transaction is characterized), the
        Corresponding Source conveyed under this section must be accompanied
        by the Installation Information.  But this requirement does not apply
        if neither you nor any third party retains the ability to install
        modified object code on the User Product (for example, the work has
        been installed in ROM).
        
          The requirement to provide Installation Information does not include a
        requirement to continue to provide support service, warranty, or updates
        for a work that has been modified or installed by the recipient, or for
        the User Product in which it has been modified or installed.  Access to a
        network may be denied when the modification itself materially and
        adversely affects the operation of the network or violates the rules and
        protocols for communication across the network.
        
          Corresponding Source conveyed, and Installation Information provided,
        in accord with this section must be in a format that is publicly
        documented (and with an implementation available to the public in
        source code form), and must require no special password or key for
        unpacking, reading or copying.
        
          7. Additional Terms.
        
          "Additional permissions" are terms that supplement the terms of this
        License by making exceptions from one or more of its conditions.
        Additional permissions that are applicable to the entire Program shall
        be treated as though they were included in this License, to the extent
        that they are valid under applicable law.  If additional permissions
        apply only to part of the Program, that part may be used separately
        under those permissions, but the entire Program remains governed by
        this License without regard to the additional permissions.
        
          When you convey a copy of a covered work, you may at your option
        remove any additional permissions from that copy, or from any part of
        it.  (Additional permissions may be written to require their own
        removal in certain cases when you modify the work.)  You may place
        additional permissions on material, added by you to a covered work,
        for which you have or can give appropriate copyright permission.
        
          Notwithstanding any other provision of this License, for material you
        add to a covered work, you may (if authorized by the copyright holders of
        that material) supplement the terms of this License with terms:
        
            a) Disclaiming warranty or limiting liability differently from the
            terms of sections 15 and 16 of this License; or
        
            b) Requiring preservation of specified reasonable legal notices or
            author attributions in that material or in the Appropriate Legal
            Notices displayed by works containing it; or
        
            c) Prohibiting misrepresentation of the origin of that material, or
            requiring that modified versions of such material be marked in
            reasonable ways as different from the original version; or
        
            d) Limiting the use for publicity purposes of names of licensors or
            authors of the material; or
        
            e) Declining to grant rights under trademark law for use of some
            trade names, trademarks, or service marks; or
        
            f) Requiring indemnification of licensors and authors of that
            material by anyone who conveys the material (or modified versions of
            it) with contractual assumptions of liability to the recipient, for
            any liability that these contractual assumptions directly impose on
            those licensors and authors.
        
          All other non-permissive additional terms are considered "further
        restrictions" within the meaning of section 10.  If the Program as you
        received it, or any part of it, contains a notice stating that it is
        governed by this License along with a term that is a further
        restriction, you may remove that term.  If a license document contains
        a further restriction but permits relicensing or conveying under this
        License, you may add to a covered work material governed by the terms
        of that license document, provided that the further restriction does
        not survive such relicensing or conveying.
        
          If you add terms to a covered work in accord with this section, you
        must place, in the relevant source files, a statement of the
        additional terms that apply to those files, or a notice indicating
        where to find the applicable terms.
        
          Additional terms, permissive or non-permissive, may be stated in the
        form of a separately written license, or stated as exceptions;
        the above requirements apply either way.
        
          8. Termination.
        
          You may not propagate or modify a covered work except as expressly
        provided under this License.  Any attempt otherwise to propagate or
        modify it is void, and will automatically terminate your rights under
        this License (including any patent licenses granted under the third
        paragraph of section 11).
        
          However, if you cease all violation of this License, then your
        license from a particular copyright holder is reinstated (a)
        provisionally, unless and until the copyright holder explicitly and
        finally terminates your license, and (b) permanently, if the copyright
        holder fails to notify you of the violation by some reasonable means
        prior to 60 days after the cessation.
        
          Moreover, your license from a particular copyright holder is
        reinstated permanently if the copyright holder notifies you of the
        violation by some reasonable means, this is the first time you have
        received notice of violation of this License (for any work) from that
        copyright holder, and you cure the violation prior to 30 days after
        your receipt of the notice.
        
          Termination of your rights under this section does not terminate the
        licenses of parties who have received copies or rights from you under
        this License.  If your rights have been terminated and not permanently
        reinstated, you do not qualify to receive new licenses for the same
        material under section 10.
        
          9. Acceptance Not Required for Having Copies.
        
          You are not required to accept this License in order to receive or
        run a copy of the Program.  Ancillary propagation of a covered work
        occurring solely as a consequence of using peer-to-peer transmission
        to receive a copy likewise does not require acceptance.  However,
        nothing other than this License grants you permission to propagate or
        modify any covered work.  These actions infringe copyright if you do
        not accept this License.  Therefore, by modifying or propagating a
        covered work, you indicate your acceptance of this License to do so.
        
          10. Automatic Licensing of Downstream Recipients.
        
          Each time you convey a covered work, the recipient automatically
        receives a license from the original licensors, to run, modify and
        propagate that work, subject to this License.  You are not responsible
        for enforcing compliance by third parties with this License.
        
          An "entity transaction" is a transaction transferring control of an
        organization, or substantially all assets of one, or subdividing an
        organization, or merging organizations.  If propagation of a covered
        work results from an entity transaction, each party to that
        transaction who receives a copy of the work also receives whatever
        licenses to the work the party's predecessor in interest had or could
        give under the previous paragraph, plus a right to possession of the
        Corresponding Source of the work from the predecessor in interest, if
        the predecessor has it or can get it with reasonable efforts.
        
          You may not impose any further restrictions on the exercise of the
        rights granted or affirmed under this License.  For example, you may
        not impose a license fee, royalty, or other charge for exercise of
        rights granted under this License, and you may not initiate litigation
        (including a cross-claim or counterclaim in a lawsuit) alleging that
        any patent claim is infringed by making, using, selling, offering for
        sale, or importing the Program or any portion of it.
        
          11. Patents.
        
          A "contributor" is a copyright holder who authorizes use under this
        License of the Program or a work on which the Program is based.  The
        work thus licensed is called the contributor's "contributor version".
        
          A contributor's "essential patent claims" are all patent claims
        owned or controlled by the contributor, whether already acquired or
        hereafter acquired, that would be infringed by some manner, permitted
        by this License, of making, using, or selling its contributor version,
        but do not include claims that would be infringed only as a
        consequence of further modification of the contributor version.  For
        purposes of this definition, "control" includes the right to grant
        patent sublicenses in a manner consistent with the requirements of
        this License.
        
          Each contributor grants you a non-exclusive, worldwide, royalty-free
        patent license under the contributor's essential patent claims, to
        make, use, sell, offer for sale, import and otherwise run, modify and
        propagate the contents of its contributor version.
        
          In the following three paragraphs, a "patent license" is any express
        agreement or commitment, however denominated, not to enforce a patent
        (such as an express permission to practice a patent or covenant not to
        sue for patent infringement).  To "grant" such a patent license to a
        party means to make such an agreement or commitment not to enforce a
        patent against the party.
        
          If you convey a covered work, knowingly relying on a patent license,
        and the Corresponding Source of the work is not available for anyone
        to copy, free of charge and under the terms of this License, through a
        publicly available network server or other readily accessible means,
        then you must either (1) cause the Corresponding Source to be so
        available, or (2) arrange to deprive yourself of the benefit of the
        patent license for this particular work, or (3) arrange, in a manner
        consistent with the requirements of this License, to extend the patent
        license to downstream recipients.  "Knowingly relying" means you have
        actual knowledge that, but for the patent license, your conveying the
        covered work in a country, or your recipient's use of the covered work
        in a country, would infringe one or more identifiable patents in that
        country that you have reason to believe are valid.
        
          If, pursuant to or in connection with a single transaction or
        arrangement, you convey, or propagate by procuring conveyance of, a
        covered work, and grant a patent license to some of the parties
        receiving the covered work authorizing them to use, propagate, modify
        or convey a specific copy of the covered work, then the patent license
        you grant is automatically extended to all recipients of the covered
        work and works based on it.
        
          A patent license is "discriminatory" if it does not include within
        the scope of its coverage, prohibits the exercise of, or is
        conditioned on the non-exercise of one or more of the rights that are
        specifically granted under this License.  You may not convey a covered
        work if you are a party to an arrangement with a third party that is
        in the business of distributing software, under which you make payment
        to the third party based on the extent of your activity of conveying
        the work, and under which the third party grants, to any of the
        parties who would receive the covered work from you, a discriminatory
        patent license (a) in connection with copies of the covered work
        conveyed by you (or copies made from those copies), or (b) primarily
        for and in connection with specific products or compilations that
        contain the covered work, unless you entered into that arrangement,
        or that patent license was granted, prior to 28 March 2007.
        
          Nothing in this License shall be construed as excluding or limiting
        any implied license or other defenses to infringement that may
        otherwise be available to you under applicable patent law.
        
          12. No Surrender of Others' Freedom.
        
          If conditions are imposed on you (whether by court order, agreement or
        otherwise) that contradict the conditions of this License, they do not
        excuse you from the conditions of this License.  If you cannot convey a
        covered work so as to satisfy simultaneously your obligations under this
        License and any other pertinent obligations, then as a consequence you may
        not convey it at all.  For example, if you agree to terms that obligate you
        to collect a royalty for further conveying from those to whom you convey
        the Program, the only way you could satisfy both those terms and this
        License would be to refrain entirely from conveying the Program.
        
          13. Use with the GNU Affero General Public License.
        
          Notwithstanding any other provision of this License, you have
        permission to link or combine any covered work with a work licensed
        under version 3 of the GNU Affero General Public License into a single
        combined work, and to convey the resulting work.  The terms of this
        License will continue to apply to the part which is the covered work,
        but the special requirements of the GNU Affero General Public License,
        section 13, concerning interaction through a network will apply to the
        combination as such.
        
          14. Revised Versions of this License.
        
          The Free Software Foundation may publish revised and/or new versions of
        the GNU General Public License from time to time.  Such new versions will
        be similar in spirit to the present version, but may differ in detail to
        address new problems or concerns.
        
          Each version is given a distinguishing version number.  If the
        Program specifies that a certain numbered version of the GNU General
        Public License "or any later version" applies to it, you have the
        option of following the terms and conditions either of that numbered
        version or of any later version published by the Free Software
        Foundation.  If the Program does not specify a version number of the
        GNU General Public License, you may choose any version ever published
        by the Free Software Foundation.
        
          If the Program specifies that a proxy can decide which future
        versions of the GNU General Public License can be used, that proxy's
        public statement of acceptance of a version permanently authorizes you
        to choose that version for the Program.
        
          Later license versions may give you additional or different
        permissions.  However, no additional obligations are imposed on any
        author or copyright holder as a result of your choosing to follow a
        later version.
        
          15. Disclaimer of Warranty.
        
          THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
        APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
        HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
        OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
        THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
        PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
        IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
        ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
        
          16. Limitation of Liability.
        
          IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
        WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
        THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
        GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
        USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
        DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
        PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
        EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
        SUCH DAMAGES.
        
          17. Interpretation of Sections 15 and 16.
        
          If the disclaimer of warranty and limitation of liability provided
        above cannot be given local legal effect according to their terms,
        reviewing courts shall apply local law that most closely approximates
        an absolute waiver of all civil liability in connection with the
        Program, unless a warranty or assumption of liability accompanies a
        copy of the Program in return for a fee.
        
                             END OF TERMS AND CONDITIONS
        
                    How to Apply These Terms to Your New Programs
        
          If you develop a new program, and you want it to be of the greatest
        possible use to the public, the best way to achieve this is to make it
        free software which everyone can redistribute and change under these terms.
        
          To do so, attach the following notices to the program.  It is safest
        to attach them to the start of each source file to most effectively
        state the exclusion of warranty; and each file should have at least
        the "copyright" line and a pointer to where the full notice is found.
        
            <one line to give the program's name and a brief idea of what it does.>
            Copyright (C) <year>  <name of author>
        
            This program is free software: you can redistribute it and/or modify
            it under the terms of the GNU General Public License as published by
            the Free Software Foundation, either version 3 of the License, or
            (at your option) any later version.
        
            This program is distributed in the hope that it will be useful,
            but WITHOUT ANY WARRANTY; without even the implied warranty of
            MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
            GNU General Public License for more details.
        
            You should have received a copy of the GNU General Public License
            along with this program.  If not, see <http://www.gnu.org/licenses/>.
        
        Also add information on how to contact you by electronic and paper mail.
        
          If the program does terminal interaction, make it output a short
        notice like this when it starts in an interactive mode:
        
            <program>  Copyright (C) <year>  <name of author>
            This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
            This is free software, and you are welcome to redistribute it
            under certain conditions; type `show c' for details.
        
        The hypothetical commands `show w' and `show c' should show the appropriate
        parts of the General Public License.  Of course, your program's commands
        might be different; for a GUI interface, you would use an "about box".
        
          You should also get your employer (if you work as a programmer) or school,
        if any, to sign a "copyright disclaimer" for the program, if necessary.
        For more information on this, and how to apply and follow the GNU GPL, see
        <http://www.gnu.org/licenses/>.
        
          The GNU General Public License does not permit incorporating your program
        into proprietary programs.  If your program is a subroutine library, you
        may consider it more useful to permit linking proprietary applications with
        the library.  If this is what you want to do, use the GNU Lesser General
        Public License instead of this License.  But first, please read
        <http://www.gnu.org/philosophy/why-not-lgpl.html>.
        
Requires-Python: <4.0,>=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: textual>=0.60
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: tzlocal>=5.3.1
Requires-Dist: certifi>=2024.2.2
Requires-Dist: packaging>=25.0
Requires-Dist: pydantic>=2.11.7
Requires-Dist: jinja2>=3.1.6
Requires-Dist: click>=8.2.1
Requires-Dist: lorem>=0.1.1
Requires-Dist: readchar>=4.2.1
Requires-Dist: numpy!=2.4.0,>=2.3.3
Requires-Dist: pyperclip>=1.11.0
Requires-Dist: tomlkit>=0.13.3
Provides-Extra: dev
Requires-Dist: lorem>=0.1.1; extra == "dev"
Requires-Dist: pre-commit>=3.6.0; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest>=8.0.0; extra == "test"
Requires-Dist: pytest-cov>=4.1.0; extra == "test"
Requires-Dist: freezegun>=1.4.0; extra == "test"
Requires-Dist: pytest-mock>=3.12.0; extra == "test"
Dynamic: license-file

<table>
  <tr>
    <td style="vertical-align: top; width: 60%;">
      <h1>tklr</h1>
      <p>
        The term <em>tickler file</em> originally referred to a file system for reminders which used 12 monthly files and 31 daily files in which nothing worth remembering ever got lost. <em>Tklr</em> turns this classic into a local, SQLite-backed reminder system. You enter reminders in plain text; <em>tklr</em> parses dates, recurrence, and metadata as you type, then ranks tasks by urgency and goals by priority.
</p>
<p>Why try it?
</p><ul>
<li>Form‑free entry with live prompts (no forms to fill).</li>
<li>CLI and Textual UI with mouse‑free navigation.</li>
<li>Multiple reminder types: events, tasks, projects, goals, notes, jots, drafts.</li>
<li>GTD support (Capture, Clarify, Organize) using <em>jots</em>.</li>
<li>Flexible scheduling (fuzzy dates, recurrence, time zones) powered by <em>dateutil</em>.</li>
<li>Organized views (Agenda, Later/Earlier, Queries, bins, hashtags) to surface what matters.</li>
</ul>

<p>If you like fast, local, keyboard‑first tools, <em>tklr</em> gives you a daily brief without a heavyweight app.</p>
    </td>
    <td style="width: 40%; vertical-align: middle;">
      <figure style="margin: 20px; text-align: center;">
        <img src="https://raw.githubusercontent.com/dagraham/tklr-dgraham/master/tklr_logo.avif"
             alt="tklr logo" title="Tklr" style="max-width: 380px; width: 100%; height: auto;">
        <figcaption style="margin-top: 6px; font-style: italic;">Make the most of your time!</figcaption>
      </figure>
    </td>
  </tr>
</table>


Ready to dive deeper? This introduction is best viewed at [GitHub.io](https://dagraham.github.io/tklr-dgraham/). *Tklr* itself is available from [PyPi](https://pypi.org/project/tklr-dgraham/), the source code from [GitHub](https://github.com/dagraham/tklr-dgraham), recent updates at [Recent Changes](https://github.com/dagraham/tklr-dgraham/blob/master/recent_changes.md) and further discussion at [Tklr discussions](https://github.com/dagraham/tklr-dgraham/discussions).

<a id="table-of-contents"></a>
<h3>Table of Contents</h3>

<details>
  <summary><strong>Show/Hide</strong></summary>
  <ul>
    <li>
      <details>
        <summary><a href="#1-what-makes-tklr-different">1. What makes <em>tklr</em> different</a></summary>
        <ul>
          <li><a href="#11-form-free-entry">1.1. Form-Free entry</a></li>
          <li><a href="#12-reminders-to-suit-the-purpose">1.2. Reminders to suit the purpose</a></li>
          <li><a href="#13-mouse-free-navigation">1.3. Mouse-Free navigation</a></li>
          <li><a href="#14-agenda-view-your-daily-brief">1.4. Agenda View: Your daily brief</a></li>
          <li><a href="#15-weeks-view-and-friends">1.5. Weeks View and friends</a></li>
          <li><a href="#16-jots-and-jot-uses-views-where-did-the-time-go">1.6. Jots and Jot Uses Views: Where did the time go</a></li>
          <li><a href="#17-jots-and-gtd">1.7. Jots and GTD</a></li>
          <li><a href="#18-gtd-and-task-view">1.8. GTD and Task View</a></li>
          <li><a href="#19-bins-and-hash-tags-views-organizing-your-reminders">1.9. Bins and Hash-Tags Views: Organizing your reminders</a></li>
          <li><a href="#110-query-and-find-views-wheres-waldo">1.10. Query and Find Views: Where's Waldo</a></li>
          <li><a href="#111-sqlite3-data-store">1.11. SQLite3 Data Store</a></li>
        </ul>
      </details>
      <details>
        <summary><a href="#2-details">2. Details</a></summary>
        <ul>
          <li><a href="#21-datetimes">2.1. Datetimes</a></li>
          <li><a href="#22-timedeltas">2.2. TimeDeltas</a></li>
          <li><a href="#23-scheduled-datetime">2.3. Scheduled datetime</a></li>
          <li><a href="#24-extent-timedelta">2.4. Extent timedelta</a></li>
          <li><a href="#25-notice">2.5. Notice</a></li>
          <li><a href="#26-wrap">2.6. Wrap</a></li>
          <li><a href="#27-alert">2.7. Alert</a></li>
          <li><a href="#28-recurrence">2.8. Recurrence</a></li>
          <li><a href="#29-masked-information">2.9. Masked Information</a></li>
          <li><a href="#210-hashtags">2.10. HashTags</a></li>
          <li><a href="#211-anniversaries">2.11. Anniversaries</a></li>
          <li><a href="#212-timezones">2.12. Timezones</a></li>
          <li><a href="#213-urgency">2.13. Urgency</a></li>
          <li><a href="#214-priority">2.14. Priority</a></li>
          <li><a href="#215-open-with-default">2.15. Open with default</a></li>
          <li><a href="#216-away-from-your-computer-use-the-cloud">2.16. Away from your computer? Use the cloud</a></li>
          <li><a href="#217-palette-view-customizing-theme-color-settings">2.17. Palette View: Customizing Theme Color Settings</a></li>
          <li><a href="#218-token-keys">2.18. Token Keys</a></li>
        </ul>
      </details>
      <details>
        <summary><a href="#3-getting-started">3. Getting Started</a></summary>
      </details>
      <details>
        <summary><a href="#4-using-the-command-line-interface">4. Using the Command Line Interface</a></summary>
      </details>
      <details>
        <summary><a href="#5-coming-from-etm">5. Coming from <em>etm</em></a></summary>
      </details>
      <details>
        <summary><a href="#6-developer-guide">6. Developer Guide</a></summary>
      </details>
    </li>
  </ul>
</details>

<p>This <em>Table of Contents</em> is expandable with links to all the major sections and with <code>↩︎</code> links throughout the document to return to it.</p>



## 1. What makes tklr different

### 1.1. Form-Free entry

<div style="overflow: auto;">
  <img src="https://raw.githubusercontent.com/dagraham/tklr-dgraham/master/screenshots/demo.gif" alt="Description" style="float: right; margin-left: 20px; width: 460px; margin-bottom: 10px;">
  <p>
Rather than filling out fields in a form to create or edit reminders, a simple entry field is provided for text input together with a prompt area which provides <i>instantaneous feedback</i>.
  </p>
<p>
  This animation shows the entire process for creating a new reminder. The individual entry steps are listed below.
</p>

<ul>
  <li>the type character, here an <code>*</code> for an <em>event</em>
  </li>
  <li>the subject, "Lunch with Ed"
  </li>
  <li>the scheduled time, <code>@s 12p</code> - today is assumed
  </li>
  <li>the extent (duration) of the event, <code>@e 1h30m</code> - an hour and thirty minutes
  </li>
  <li>an alert, <code>@e 15m: n</code> - fifteen minutes before the event, trigger a notification
  </li>
  <li>the resulting event displayed in <em>Agenda View</em>
  </li>
</ul>

</div>
<div style="clear: both;"></div>

<div style="overflow: auto;">
  <img src="https://raw.githubusercontent.com/dagraham/tklr-dgraham/master/screenshots/AppleCalendar.png" alt="Description" style="float: right; margin-left: 80px; margin-right: 80px; width: 300px; margin-bottom: 10px;">
<p>
In comparison, here is how the reminder would be created using Apple's <em>Calendar</em> App. 
</p>

<ul>
  <li>the type would be selected by clicking on the <em>event</em> tab </li>
  <li>the subject by clicking in the next entry area and entering "Lunch with Ed"</li>
  <li>the scheduled time by clicking in the calendar area and then selecting one by one:

  <ul>
    <li>the year</li>
    <li>the month</li>
    <li>the month day</li>
    <li>the hour</li>
    <li>the minutes</li>
    <li>am or pm</li>
  </ul>
  
  </li>

  <li>the ending time following the same one by one process</li>
  <li>the alert by clicking the tab and selecting <em>15 minutes before</em> from a list</li>

</ul>

<p><em>Tklr</em>'s form-free approach is particularly advantageous when entering dates and times.</p> 

<ul>
  <li>a time: today's date is assumed if a date is not specified, e.g., <code>@s 11a</code> is iterpreted as 11:00AM today.</li>
  <li>a weekday: the next date with that weekday is assumed, <code>@s fri</code> means the next Friday on or after today.</li>
  <li>a monthday only: the current month is assumed.</li>
  <li>a month and monthday: the current year is assumed.</li> 
</ul>
<p>The details are in <a href="#21-datetimes">2.1. Datetimes</a>.</p>

</div>
<div style="clear: both;"></div>

<div style="overflow: auto;">
  <img src="https://raw.githubusercontent.com/dagraham/tklr-dgraham/master/screenshots/wrap_noargs.svg" alt="Description" style="float: right; margin-left: 20px; width: 460px; margin-bottom: 10px;">

<p>How does <em>tklr</em> support the other <em>Calendar</em> options? 
</p>

<ul>
  <li>location: <code>@l General Store, Saxapahaw</code></li>
  <li>all day: March 12 of this year, <code>@s 3/12</code></li>
  <li>not all day: 12pm on March 12 of this year, <code>@s 3/12 12p</code></li>
  <li>repeat: weeky, <code>@r w</code></li>
  <li>travel time, thirty minutes before the event and 40 minutes after the event <code>@w 30m, 40m</code> </li>
  <li>busy: include <code>@e 1h30m</code></li>
  <li>not busy, omit <code>@e</code></li>
  <li>invitees: <code>@i Sam Jones, Bill Smith</code></li>
  <li>notes: <code>@d bring crackers and cheese</code></li>
  <li>URL: 
    <code>@g https://dagraham.github.io/tklr-dgraham/</code></li>
</ul>

</div>
<div style="clear: both;"></div>

<div style="overflow: auto;">
  <img src="https://raw.githubusercontent.com/dagraham/tklr-dgraham/master/screenshots/wrap_args.svg" alt="Description" style="float: right; margin-left: 20px; width: 460px; margin-bottom: 10px;">

<p>How can you remember all the <em>tklr</em> options? 
</p>

<p>You don't need to. When you are entering a reminder, after you enter character <code>@</code>, the list of available <code>@-keys</code> will be listed below. Most are suggestive, e.g., <code>s</code> for "scheduled", <code>d</code> for "details", and so forth, but you can just enter one of the characters, e.g., <code>@w</code>, and the description will be listed in the feedback below.
</p>

<p>All of the token keys are listed in <a href="#218-token-keys">2.18. Token Keys</a>.</p>

</div>
<div style="clear: both;"></div>


[↩︎](#table-of-contents)


### 1.2. Reminders to suit the purpose

*tklr* has seven types of reminders, each with a corresponding type character:

| item type | character | description                             |
| --------- | :-------: | --------------------------------------- |
| event     |     *     | happens at a particular time            |
| task      |     ~     | requires an action to complete          |
| project   |     ^     | collection of related tasks             |
| goal      |     !     | targets action at a specified frequency |
| note      |     %     | information for future reference        |
| jot       |     -     | timestamped message to self             |
| draft     |     ?     | preliminary/unfinished reminder         |

Here are some illustrations of how the various types.

<a id="reminder-types"></a>

<ul>
  <li><a href="#121-an-event-lunch-with-ed-extended">1.2.1. An <em>event</em>: lunch with Ed (discussed)</a></li>
  <li><a href="#122-a-task-pick-up-milk">1.2.2. A <em>task</em>: pick up milk</a></li>
  <li><a href="#123-a-repeating-event-trash-pickup">1.2.3. A <em>repeating event</em>: trash pickup</a></li>
  <li><a href="#124-an-event-that-repeats-irregularly-dental-appointment">1.2.4. An <em>event that repeats irregularly</em>: dental appointment</a></li>
  <li><a href="#125-a-complicated-but-regularly-repeating-task-vote-for-president">1.2.5. A <em>complicated</em> but regularly repeating task: vote for president</a></li>
  <li><a href="#126-an-offset-task-fill-bird-feeders">1.2.6. An <em>offset task</em>: fill bird feeders</a></li>
  <li><a href="#127-a-note-a-favorite-churchill-quotation">1.2.7. A <em>note</em>: a favorite Churchill quotation</a></li>
  <li><a href="#128-projects-with-and-without-prerequisites">1.2.8. <em>projects</em>: with and without prerequisites</a></li>
  <li><a href="#129-a-goal-interval-training-3-times-each-week">1.2.9. A <em>goal</em>: interval training 3 times each week</a></li>
  <li><a href="#1210-a-jot-taking-a-walk">1.2.10. A <em>jot</em>: taking a walk</a></li>
  <li><a href="#1211-a-draft-reminder-meet-alex-for-coffee---time-to-be-determined">1.2.11. A <em>draft</em> reminder: meet Alex for coffee - time to be determined</a></li>
</ul>

#### 1.2.1. An _event_: lunch with Ed (extended)

<div style="overflow:auto;">
  <pre style="float:right; margin-left:20px; width:460px; background:#111; color:#ddd; padding:12px; border-radius:6px;">
<code>* lunch with Ed
  @s 12p fri @e 1h30m
  @a 15m: n
</code>
  </pre>
<p>The <code>*</code> makes this reminder an <i>event</i> with whatever follows until the next <code>@</code> character as the subject. The <code>@s</code> attribute sets the <i>scheduled</i> or starting time for 12pm on the first Friday on or after today and the <code>@e 1h30m</code> attribute sets the <i>extent</i> for one hour and thirty minutes. This event will thus be displayed as occupying the period <code>12-1:30pm</code> on the day of the event. The distinguishing feature of an <i>event</i> is that it occurs at a particular time and the <code>@s</code> attribute is therefore required.
</p>
<p>Provided that <em>tklr ui</em> is running, <code>@a 15m: n</code> will trigger a built-in <em>notify</em> alert fifteen minutes before the start of the event which sounds a bell and posts a message on the <em>tklr</em> display showing the subject and time of the event.
</p>
</div>
<div style="clear:both;"></div>


#### 1.2.2. A _task_: pick up milk

<div style="overflow:auto;">
  <pre style="float:right; margin-left:20px; width:460px; background:#111; color:#ddd; padding:12px; border-radius:6px;">
<code>~ pick up milk
</code>
  </pre>
  <p>The beginning <code>~</code> type character makes this reminder a <i>task</i> with the following <code>pick up milk</code> as the <i>subject</i>.
  </p>

  <p>Using an <code>@s</code> attribute is optional and, when specified, it sets the time at which the task should be <strong>completed</strong>, not begun. The <code>@e</code> attribute is also optional and, when given, is intepreted as the estimated time period required for completion.
  </p>
</div>
<div style="clear:both;"></div>


#### 1.2.3. A _repeating event_: trash pickup

<div style="overflow:auto;">
  <pre style="float:right; margin-left:20px; width:460px; background:#111; color:#ddd; padding:12px; border-radius:6px;">
<code>* trash pickup @s 8a mon @n 1d @r w &w MO
</code>
  </pre>
<p>This <em>event</em> repeats because of the <code>@r w &w MO</code> each week on Mondays. Because of the <code>@n 1d</code> a notice will be posted in <em>Agenda View</em> when the current date is within one day of the scheduled datetime or, in this case, on Sundays. This serves as a reminder to put the trash at the curb before 8am Mondays. Why not use a <em>task</em> for this? A task would require being marked finished each week to avoid accumulating past due instances - even when out of town with neither trash nor opportunity for placement at the curb.
</p>
</div>
<div style="clear:both;"></div>


#### 1.2.4. An _event that repeats irregularly_: dental appointment

<div style="overflow:auto;">
  <pre style="float:right; margin-left:20px; width:460px; background:#111; color:#ddd; padding:12px; border-radius:6px;">
<code>* dental exam and cleaning
  @s 2p feb 5
  @e 45m
  @+ 9am Sep 3
</code>
  </pre>
<p>This event specifies an appointment for a 45 minute dental exam and cleaning starting at 2pm on February 5 and then again, because of the <code>@+</code> attribute, at 9am on September 3.
</p>

<p>Need to add another datetime to an existing reminder? Just add an <code>@+</code> attribute with a comma separated list of as many additional dates or datetimes as needed.
</p>
</div>
<div style="clear:both;"></div>


#### 1.2.5. A _complicated_ but regularly repeating task: vote for president

<div style="overflow:auto;">
  <pre style="float:right; margin-left:20px; width:460px; background:#111; color:#ddd; padding:12px; border-radius:6px;">
<code>~ vote for president
  @s nov 1 2020
  @r y &i 4 &w TU &d 2, 3, 4, 5, 6, 7, 8 &m 11
</code>
  </pre>
  <p>Here is another, more complicated, but still <em>regularly repeating</em> reminder. Beginning with November, 2020, this <em>task</em> repeats every 4 years on the first Tuesday after a Monday in November (a <em>Tuesday</em> whose <em>month day</em> falls between 2 and 8 in the 11th <em>month</em>).
  </p>

  <p>This is a good illustration of the power of the <em>dateutil</em> library. Note that the only role of <code>@s nov 1 2020</code> is to limit the repetitions generated by <code>@r</code> to those falling on or after November 1, 2020 and occur on that year or a multiple of 4 years after that year.
  </p>
</div>
<div style="clear:both;"></div>

#### 1.2.6. An _offset task_: fill bird feeders

<div style="overflow:auto;">
  <pre style="float:right; margin-left:20px; width:460px; background:#111; color:#ddd; padding:12px; border-radius:6px;">
<code>~ fill birdfeeders @s 3p sat @n 1d @o 12d
</code>
  </pre>
<p>Because of the <code>@o 12d</code> <em>offset</em> attribute, when this task is completed the <code>@s</code> <em>scheduled</em> datetime will automatically reset to the datetime that falls precisely 12 days after the completion datetime. Whether they are filled early or late, they will still need to be refilled 12 days after they were last filled.</p>

<p>Because of the <code>@n 1d</code> <em>notice</em> attribute, this task will <em>not</em> appear in the <em>Agenda View</em> task list until the current datetime is within one day of the <em>scheduled</em> datetime. Without this <em>notice</em> attribute, the default would have been to use the <em>offset</em> value as an implicit <em>notice</em> setting, i.e., not to display the task until the current datetime is within 12 days of the <em>scheduled</em> datetime. 
</p>
</div>
<div style="clear:both;"></div>

Since the <code>@o</code> attribute involves resetting attributes  in a way that effectively repeats the <em>task</em>:

1. `@o` can only be used with _tasks_
2. Using `@o` precludes the use of `@r`


It is worth noting the different roles of two attributes in events and tasks.

1. The <em>scheduled</em> datetime attribute describes when an event begins but when a task should be completed.
2. The <em>notice</em> attribute provides an early warning for an event but postpones the disclosure of a task.


#### 1.2.7. A _note_: a favorite Churchill quotation

<div style="overflow:auto;">
  <pre style="float:right; margin-left:20px; width:460px; background:#111; color:#ddd; padding:12px; border-radius:6px;">
<code>% Give me a pig - #Churchill
  @d Dogs look up at you.
  Cats look down at you.
  Give me a pig - they look you in the eye
    and treat you as an equal.
  @b quotations
</code>
  </pre>
  <p>The beginning <code>%</code> makes this reminder a <i>note</i> with the <i>subject</i>, <code>Give me a pig - #Churchill</code>. The optional <i>details</i> attribute follows the <code>@d</code> and is meant to be more expansive - analogous to the body of an email. The hash character that precedes 'Churchill' in the subject makes that word a <i>hash tag</i> for listing in <i>Tags View</i>. The <code>@b</code> entry adds this reminder to the 'quotations' <i>bin</i> for listing in <i>Bins View</i>.
  </p>
</div>
<div style="clear:both;"></div>



<a id="doghouse-example"></a>

#### 1.2.8. _projects_: with and without prerequisites

<div style="overflow:auto;">
  <pre style="float:right; margin-left:20px; width:460px; background:#111; color:#ddd; padding:12px; border-radius:6px;">
<code>
^ Build dog house
  @~ pick up materials &r 1 
  @~ cut pieces &r 2: 1 
  @~ assemble &r 3: 2 
  @~ sand &r 4: 3
  @~ paint &r 5: 4 
  @d these tasks must be done in order, 
     each is a prerequiste for the next
</code>
<code>
^ Apply fertilizer
  @~ daffodils behind house &r 1
  @~ azalias by entrance &r 2 
  @~ crepe myrtles by driveway &r 3 
  @d these tasks can be done in any order, 
     none have prerequisites
</code>
  </pre>
      <p>The beginning <code>^</code> makes these reminders <i>projects</i>. The first is a collection of related tasks specified by the <code>@~</code> entries. In each task, the <code>&r X: Y</code> <em>requires</em> attribute sets the integer <code>X</code> as the label for the task and sets the task labeled with integer <code>Y</code> as a requirement or prerequisite for <code>X</code>. E.g., <code>&r 3: 2</code> establishes "3" as the label for assemble and "2" (cut pieces) as a prerequisite. 
      </p>
      <p>
      The second is also a collection of related tasks but none of the <code>&r X</code> entries specify either of the other tasks as a prerequisite. These tasks can be done in any order.   
      </p>
      <p>
      The labels provided by the <code>&r</code> entries are required, with or without prerequisites, for each of the component <code>@~</code> tasks. 
      </p>
    </div>
<div style="clear:both;"></div>


#### 1.2.9. A _goal_: interval training 3 times each week

<div style="overflow:auto;">
  <pre style="float:right; margin-left:20px; width:460px; background:#111; color:#ddd; padding:12px; border-radius:6px;">
<code>! interval training @s 2026-01-05 @t 3/1w
</code>
  </pre>
  <p>The beginning <code>!</code> type character makes this reminder a <i>goal</i> with the following <code>interval training</code> as the <i>subject</i>. The <code>@t 3/1w</code> attribute is required and sets the <i>target</i> to be 3 completions during the period of one week starting at midnight on '2026-01-05', because of the <code>@s</code> attribute, and ending one week later at midnight on '2026-01-12', because of the '1w' target period.
  </p>
</div>
<div style="clear:both;"></div>

When a *goal* is created, the attribute `@k 0` is automatically added to indicate that the current *completion count* is zero. When a completion is recorded for the *goal*, this count is automatically increased by one. This process continues until

1. the period allowed for completing the goal expires or
2. the completion count reaches the target number of completions

In either case, `@k` is reset to zero and `@s` is reset to the previous value *plus* the period allowed for completion of the goal, i.e, to the *end* of the period originally allowed for completion.

#### 1.2.10. A _jot_: taking a walk

Tracking where a resource goes is the key to managing any scarce resource - your time is no exception. A *jot* is a reminder type designed to facilitate this purpose. It provides a way of *quickly* recording a *jot* of time-stamped information as a *message to self*. It is sufficiently different from the other reminder types to warrant some discussion before giving an example.

Imagine that *tklr* is running on your computer and that, in the midst of your hectic day, you could reach over, press "N" to create a new reminder, enter "-" to make it a *jot* and add a *subject* - a *brief* phrase - just enough to trigger your memory later. Then press Ctrl+S to save - a timestamp will automatically be added.

What might you do with these *jots*? As is, these jots can provide a record of what you were doing and when.  At the cost of a few seconds per *jot* you can have a daily record of when and what you were doing or thinking. Press "J" to see a list of all your *jots* grouped by week and weekday and, as with all other reminder views in *tklr*, tagged with lower case letters, a, b, c, .... for instant access.

When you have time, you might want to:
- flush out the *subject* or add a `@d` *details* entry to provide extra detail.
- record the time spent. You could, e.g., add `@e 1h15`, to indicate that an hour and fifteen minutes of your precious time was spent on whatever you were doing when the *jot* was recorded.
- record the particular <em>use</em> to which the *jot* applies, e.g., `@u exercise.walking` to indicate that this time should be attributed to the *use* "exercise.walking". Press "U" whenever you like to see a report of your *Jot Uses* with *totals* of your time spent by *month* and *use*.
- add a hash-tag to the subject or the details of a *jot* to make it easy to find in the *Hash-Tags View*.
- convert it to another type of reminder. E.g. `- book a lunch reservation for Friday` might be converted to the event `* lunch with Ed @s fri 1pm` when you make the reservation.

Underneath the details is a very simple idea - in the heat of battle when every second counts, *jot* down just enough to trigger your memory later when things have calmed down.

<div style="overflow:auto;">
  <pre style="float:right; margin-left:20px;  margin-bottom:12px; width:460px; background:#111; color:#ddd; padding:12px; border-radius:6px;">
<code>- taking a walk 
</code>
  </pre>
  <p>Here's an example. The beginning <code>-</code> type character makes this reminder a <i>jot</i> with the following <code>taking a walk</code> as the <i>subject</i>. This much was <em>jotted down</em> before the walk and saved.
  </p>
</div>

<div style="overflow:auto;">
  <pre style="float:right; margin-left:20px; margin-bottom:12px; width:460px; background:#111; color:#ddd; padding:12px; border-radius:6px;">
<code>- taking a walk @s 2026-01-05 13:14
</code>
  </pre>
  <p>The <code>@s 2026-01-05 13:14</code> timestamp was automatically added by <em>tklr</em> as the reminder was being saved.
  </p>
</div>

<div style="overflow:auto;">
  <pre style="float:right; margin-left:20px; width:460px; background:#111; color:#ddd; padding:12px; border-radius:6px;">
<code>- taking a walk @s 2026-01-05 13:14
  @e 1h15m @u exercise.walking
</code>
  </pre>
  <p>Later in the day, after the walk was finished and the <em>jots</em> for the day were being reviewed, the <em>time spent</em>, <code>@e 1h15m</code>, and the <em>use</em>, <code>@u exercise.walking</code>, were added.
  </p>
  <p>Note that <code>exercise.walking</code> would serve to differentiate this form of exercise from, say, <code>exercise.interval_training</code>, and thus avoid adding "apples and oranges" when reporting the <em>use</em> totals.
  </p>
</div>
<div style="clear:both;"></div>


#### 1.2.11. A _draft_ reminder: meet Alex for coffee - time to be determined

<div style="overflow:auto;">
  <pre style="float:right; margin-left:20px; width:460px; background:#111; color:#ddd; padding:12px; border-radius:6px;">
<code>? Coffee with Alex @s fri @e 1h
</code>
  </pre>
  <p>The beginning <code>?</code> type character makes this a <i>draft</i> reminder. This can be changed to an event when the details are confirmed by replacing the <code>?</code> with an <code>*</code> and adding the time to <code>@s fri</code>.
  </p>
  <p>
  This is a reminder that is not yet finished and, in almost every respect, will be ignored by <em>tklr</em>. The exception is that it will appear highlighted on the current day in <em>Agenda View</em> until it is revised. It can be changed to an <em>event</em> when the details are confirmed by replacing the <code>?</code> with an <code>*</code> and adding the time to <code>@s</code>.
  </p>
</div>
<div style="clear:both;"></div>


[↩︎](#table-of-contents)


### 1.3. Mouse-Free navigation

Each of the main views in *tklr* can be opened by pressing a single key - the first letter of the view's name.

| View             |  Key  | Displays                                                  |
| ---------------- | :---: | --------------------------------------------------------- |
| Agenda           |   A   | events, goals, tasks                                      |
| Bins             |   B   | Tree view of Bins                                         |
| Completions      |   C   | Completion datetimes for completed tasks                  |
| Find             |   F   | Case insensitive search in subjects and details           |
| Goals            |   G   | Case insensitive search in subjects and details           |
| Hash-Tags        |   H   | List reminders with tags grouped by tag                   |
| Jots             |   J   | Jots by week and weekday                                  |
| Earlier          |   E   | The most recent instance of reminders before today        |
| Modified         |   M   | All reminders sorted by modified timestamp (newest first) |
| Later            |   L   | The next instance of reminders after today                |
| Query            |   Q   | List matches for a specified query                        |
| Remaining Alerts |   R   | List remaining alerts for today                       |
| Tasks            |   T   | List tasks grouped by category                            |
| Jot Uses         |   U   | Jots with totals by month and use                         |
| Weeks            |   W   | Scheduled reminders by week and weekday                   |


Each of these views displays a vertical list of reminders, with each reminder row beginning with a tag from "a", "b", ..., "z", followed by the pertinent details of the reminder including its subject.  When necessary, lists are split into pages so that no more than 26 reminders appear on any one page and the left and right cursor keys are used to move back and forth between pages.

*The view keys and the list tags are the key to navigating tklr.*

On any page, pressing the key corresponding to a tag will open a display with all the details of the corresponding reminder. This is worth emphasizing. *You don't need the cursor keys or the mouse to select a reminder - just press the key corresponding to its tag.*

When the details of reminder are being displayed, pressing `enter` will open a menu of various commands applicable to the selected reminder, pressing the key corresponding to the tag of another reminder will switch the details display to that reminder or pressing the upper case letter corresponding to another view will switch to that view.

Everything you might want to do to a reminder, to edit, finish, reschedule, delete or whatever is available using these steps:

1. press the key corresponding to the tag of the reminder you want to select
2. press `enter` to open the menu of commands for the selected reminder
3. press the first letter (any case) of the desired command or `escape` to cancel and close the commands menu

[↩︎](#table-of-contents)

### 1.4. Agenda View: Your daily brief

*Agenda view* displays

1. The next few days of <em>events</em> beginning with today
2. Active <em>goals</em> ordered by their *relative completion rate*
3. Available <em>tasks</em> ordered by their *urgency*

Times are displayed in the screenshots using _24-hour_ notation. An option can be set to display times using _am/pm_ notation instead.

<div style="overflow: auto;">
  <img src="https://raw.githubusercontent.com/dagraham/tklr-dgraham/master/screenshots/agenda_screenshot.svg"
alt="Description" style="float: right; margin-left: 20px; width: 460px; margin-bottom: 10px;">
  <p>While the listing of events begins with the current day, any all-day events or events whose ending times have already passed such as the one tagged <em>a</em> will be dimmed. Additionally an event, such as the one tagged <em>b</em> whose active period overlaps the current moment will be highlighted.
  </p>
  <p>The first day of events will always include any <em>notices</em> of upcoming events or <em>draft</em> reminders needing completion in addition to any scheduled events for today. In this case the reminder tagged <em>d</em> indicates that there is an event beginning in 5 days (<code>+5d</code>) with a subject beginning with "Amet porro ..." and a <em>notice attribute</em>, <code>@n x</code>, in which <code>x > 5d</code>. This attribute is the reason this notice of the event is being displayed before its scheduled datetime - it will continue to be displayed on the first day (current date) of Agenda View each day until the day of the event.
  </p>
    <p>There is also a draft entry tagged <em>e</em> and displayed in red. This is simply a reminder whose item type is <code>?</code>. This is used to flag a reminder as incomplete as would be the case, e.g., if a final datetime for the event had not yet been finalized. Draft reminders are also displayed on the current, first day in Agenda view until the item type is changed.
    </p>
    <p>The list for *goals* includes all goals which have not been completed on the current date, sorted and color coded by their *relative completion rate*, which is listed in the first column after the tags. The details for precisely how *relative completion rate* is calculated will be described later but the basic idea involves comparing</p>

  <ol>
    <li>the rate at which completions would currently need to occur to complete the goal</li>
    <li>the rate originally specified in the goal</li>
  </ol>

  <p>The higher the current rate relative to the original, the higher the *relative completion rate*.</p>

  <p>The list for *tasks* includes all tasks with the possible exception of tasks with both an `@s` (specifying a *due datetime*) and an `@n` entry (specifying a *notification period*).  Suppose, for example, that `@s 2026-01-30` and `@n 2d`. The role of these combined entries is to say that the task needs to be finished by `2026-01-30` but you don't want to be bothered about it until two days before that date. This task won't appear in the list until `2026-01-28`.</p>

  <p>Tasks are sorted by their *urgency*. This calculation is fairly complicated and will be described later. Many factors are involved including the priority of the task, its due datetime, how many tags it has, whether it has a details attribute and so forth. The *weights* attached to these and other characteristics are options which can be set in the user configuration file.</p>

  <p>*Agenda* is the default view and represents the place to go for what you need to know right now.</p>

</div>
<div style="clear: both;"></div>


[↩︎](#table-of-contents)

### 1.5. Weeks View and friends

*Weeks View* is dedicated to displaying each instance of your scheduled reminders one week at a time with a *busy bar* at the top to show the busy days during the week at a glance followed by a day by day listing of the scheduled reminders.

Two supporting views are limited to displaying a single instance of each scheduled reminder. *Later View*, bound to <code>L</code>, lists the *first* instance occurring on or after the current date in *ascending* order and *Earlier View*, bound to <code>E</code>, lists the most recent instance occurring *before* the current date in *descending* order. When did you last have your car serviced? *Earlier View* is the place to look. When is your next dental appointment? *Later View* has the answer. 

Two other views list reminders by datetime but not by the scheduled one. *Modified View*, bound to <code>M</code>, lists <strong>all</strong> reminders, whether or not they have an <code>@s</code> entry, by the *modified* timestamp in *descending* order (newest first). Want to check a reminder you just modified? It will be first in *Modified View*. In contrast, *Completions View* only lists *tasks with recorded completions* by the completed datetime in descending order (newest first). 

A final datetime listing is provided the *scheduled* category in *Tasks View* which lists scheduled *tasks* by their due datetimes in ascending order (oldest first).  

In all of these views other than Weeks, each row begins with a numeric date that respects your `config.toml` settings for `dayfirst`, `yearfirst` and `two_digit_year`.

<div style="overflow: auto;">
  <img src="https://raw.githubusercontent.com/dagraham/tklr-dgraham/master/screenshots/weeks_screenshot.svg"
alt="Description" style="float: right; margin-left: 20px; width: 460px; margin-bottom: 10px;">

  <p>Press <code>W</code> to open <em>Weeks View</em> on the current week or press <code>D</code> and enter a date to open the view on the week containing that date. The header displays the date range, year and week number for the displayed week. Left and right cursor keys shift the displayed week backward or forward by one week. Pressing the shift key at the same time increases the shift from one to four weeks. Pressing the space key will jump back to the current week.
 </p>

  <p>As with the other tagged views, pressing the key corresponding to the tag of a reminder opens a panel with the details of that reminder. In this case, the details for tag <em>j</em> are being displayed.
  </p>

  <p> The <em>busy bar</em> underneath the header provides graphical illustration of the busy times for <em>events</em> during the week. The area under each weekday name has spaces for five blocks. The first (furthest to the left) will be colored orange if one or more <em>all day</em> events are scheduled for that day. The next four blocks correspond to the four 6-hour periods during the day beginning with 00:00 - 05:59 and ending with 18:00 - 23:59 - night, morning, afternoon and evening.
  </p>
  <p>The block corresponding to a period will be green if the scheduled time for an event occupies any part of the period. E.g., a single event scheduled for 05:00 - 07:00 would cause both the first and second blocks for that day to be colored green. A block is changed from green to red if the busy periods for two or more events overlap and thus <em>conflict</em>. The red block for Tuesday, e.g., reflects the conflict during the period 11:00 - 11:15 by the events tagged <em>b</em> and <em>c</em>.
  </p>

  <p>Note that only <em>events</em> with an <em>extent</em> contribute to the <em>busy bar</em>. E.g., the <em>event</em> tagged <em>i</em> on Friday has no extent and thus no effect on the <em>busy bar</em> "morning" slot for that day. Similarly, the <em>task</em> tagged <em>j</em> whose details are displayed, is scheduled for 10:15 - 11:15 and yet, being a task, also has no effect on that "morning" slot.
  </p>

</div>
<div style="clear: both;"></div>


[↩︎](#table-of-contents)

### 1.6. Jots and Jot Uses Views: Where did the time go

These screenshots reflect a configuration setting that rounds reported <code>@e</code> times up to the next integer multiple of <code>6</code> minutes and thus reports times in hours and tenths.

The examples focus upon personal uses of time such as exercise and meditation but they might equally well have displayed professional uses involving different projects or clients.

<div style="overflow: auto;">
  <img src="https://raw.githubusercontent.com/dagraham/tklr-dgraham/master/screenshots/jots_jots.svg" alt="Description" style="float: right; margin-left: 20px; width: 460px; margin-bottom: 10px;">
  <p>
  <em>Jots View</em> is similar to <em>Weeks View</em> - reminders are grouped by <em>week</em> and then <em>week day</em> with the same key bindings used for navigation. The <em>jots</em> are displayed in different colors for
  </p><ul>
   <li>those with neither <code>@e</code> nor <code>@u</code> entries</li>
   <li>those with only <code>@e</code> entries</li>
   <li>those with only <code>@u</code> entries</li>
   <li>those with both <code>@e</code> and <code>@u</code> entries</li>
   </ul>
   When either or both of these attributes are present, they are given in parentheses after the <em>subject</em>.
  
</div>
<div style="clear: both;"></div>

<div style="overflow: auto;">
  <img src="https://raw.githubusercontent.com/dagraham/tklr-dgraham/master/screenshots/jots_uses.svg" alt="Description" style="float: right; margin-left: 20px; width: 460px; margin-bottom: 10px;">
  <p>
  <em>Jots Uses View</em> groups by <em>month</em> and <em>use</em>.  <em>Jots</em> without an entry for  <code>@u</code> are grouped under <em>unassigned</em>.
  </p>
  <p>
  The listing for each <em>jot</em> gives
  </p><ol>
  <li>tag</li>
  <li><code>@s entry</code> hours:minutes</li>
  <li><code>@s entry</code> month day</li>
  <li><code>@e entry</code></li> in hours and tenths if given else blank
  <li><em>subject</em></li>
  </ol>
  All <em>jots</em> are listed using the same colors as were used in <em>Jots View</em>.
  
</div>
<div style="clear: both;"></div>

<div style="overflow:auto;">
  <pre style="float:right; margin-left:20px; width:460px; background:#111; color:#ddd; padding:12px; border-radius:6px;">
<code>% tklr uses report --use exercise
Jot Uses - Jan 2026 - Feb 2026: 3.9h
Jan 2026: 0.5h
  exercise.bike: 0.5h
    14:13 26 0.5h Ut tempora consectetur
  exercise.walking
    12:30 31      Ut porro dolor non ut
Feb 2026: 3.4h
  exercise.bike: 1.6h
    14:13 2      Voluptatem aliquam ipsum velit
    11:00 6      Ipsum ipsum est
    11:15 6 1.3h Dolor dolorem labore sed
    13:15 8 0.3h Quaerat etincidunt quisquam dolor
  exercise.walking: 1.8h
    13:30 2      Magnam quaerat dolor non
    12:45 5 1.8h Porro est sit
    13:15 5      Adipisci tempora neque
    15:15 5      Adipisci sed voluptatem sit porro
    15:30 5      Dolorem sit dolore non dolorem
</code>
</pre>
<p>The CLI version is similar. This one using the command

<code>   tklr uses report --use exercise</code>

limits the <em>uses</em> to those containing a match for "exercise".
  </p>
</div>
<div style="clear:both;"></div>

<div style="overflow:auto;">
  <pre style="float:right; margin-left:20px; width:460px; background:#111; color:#ddd; padding:12px; border-radius:6px;">
<code>% tklr uses report --use meditation --verbose
Jot Uses - Jan 2026 - Feb 2026: 1.0h
Jan 2026
  meditation
    14:13 26      Dolore aliquam consectetur
                  u without e  #lorem
Feb 2026: 1.0h
  meditation: 1.0h
    14:13 2 0.5h Quaerat numquam eius amet
                 u and e #lorem
    12:30 5      Porro est sed
                 Porro amet quisquam eius amet labore
                 dolor. Ut labore ut quaerat dolorem
                 magnam quiquia. Quisquam non est
                 quisquam dolor neque tempora velit.
                 Dolore ut numquam sit velit aliquam
                 ipsum. #lorem #amber
    14:34 9 0.5h Dolorem quaerat quaerat consectetur
                 u and e #lorem
</code>
</pre>
<p>This one shows <em>uses</em> matching "meditation" and, because of the <code>--verbose</code> argument, also displays the <code>@d</code> <em>details</em> attribute indented under the subject.
</p>
</div>
<div style="clear:both;"></div>

[↩︎](#table-of-contents)

### 1.7. Jots and GTD

<div style="overflow: auto;">
  <img src="https://raw.githubusercontent.com/dagraham/tklr-dgraham/master/screenshots/GTD.png" alt="Description" style="float: right; margin-left: 20px; width: 460px; margin-bottom: 10px;">
  <p><em>GTD</em> refers to <em>Getting Things Done</em> - the title of a justly famous 2001 book by David Allen. The illustrated flowchart is a slightly altered version of the one in his book. Changes to the original are colored magneta and outcomes in which <em>tklr</em> plays a role are colored green.</p>  
  
  <p>Both the flowchart and the connection to <em>tklr</em> mainly involve the first three of the five steps emphasized by Allen:</p>

  <ol>
   <li><strong>Capture</strong></li>
   <li><strong>Clarify</strong></li>
   <li><strong>Organize</strong></li>
   <li>Reflect</li>
   <li>Engage</li>
  </ol>

<h4>Capture</h4>

<p><em>Get the stuff out of your head and into a bucket you can trust.</em> </p>

<p>Your concious mind is made to focus not to store. It keeps reminding you of things you're subconciously trying not to forget whether or not they are relevant to what you are trying to do and, the more you are trying not to forget, the less processing power you have left for the task at hand. These words scarcely do justice to the importance of this observation. 
</p>

<p>In <em>tklr</em>, the "bucket you can trust" is <em>jots</em> and <em>capture</em> is the stage devoted to moving the stuff from your head to <em>jots</em>. </p>

<h4>Clarify and Organize</h4>

<p>With your stuff safely stored in <em>jots</em> the next two stages are concerned with clarifying and organizing them. The phrase <em>In to Empty</em> is a motto in <em>GTD</em>, meaning that the result of applying the illustrated work flow is that every <em>inbox</em> item will have gone into one of the green boxes, leaving the <em>inbox</em> empty. There is, however, one destinaton in <em>tklr</em> for <em>jots</em> not imagined in <em>GTD</em> - the magenta <em>used time</em> box for records of time spent. Let's step through the flow and see how all this works. 
</p>

<h4>Actionable? No</h4>

<p>To be "actionable" would mean that the item is a task and one that should be completed as soon as possible.</p> 

<dl>
  
  <dt>delete</dt> 
  <dd>Is the <em>jot</em> worth saving? If not delete it.</dd>

  <dt>someday</dt>
  <dd>Is the jot something that might be actionable someday? If so, change the reminder type to <code>~</code> (task), remove the <em>scheduled</em> <code>@s</code> entry and set the <em>context</em> to <code>@c someday</code>. </dd> 

  <dt>reference</dt>
  <dd>Does the jot represent useful information that you might want to reference later? If so, change the reminder type to <code>%</code> (note) and "file" it in an appropriate <em>bin</em> using <code>@b</code>. </dd>

  <dt>used time</dt>
  <dd>Does the jot represent a use of time that you want to preserve? If so, leave the reminder type as is, <code>-</code> (jot) and set the <em>extent</em> using <code>@e</code> and/or the <em>use</em> using <code>@u</code> accordingly. Adjust the <em>scheduled</em> <code>@s</code> entry if necessary to correspond to the relevant datetime. Having either an <code>@e</code> or an <code>@u</code> entry effectively removes the jot from further consideration in the workflow.</dd> 

</dl>

<h4>Actionable? Yes</h4>

<dl>
  <dt>single step to complete?</dt>
  <dd>If not, start a project for it. Change the reminder type to <code>^</code> (project), remove the <em>scheduled</em> <code>@s</code> entry and consider adding a <em>component task</em> <code>@~</code> for the first step to take on the project.</dd>


  <dt>less than 2 minutes?</dt>
  <dd>If so, do it. Then change the reminder type to <code>~</code> (task) and add the <em>finished</em> datetime using <code>@f</code>.</dd>

  <dt>delegate it</dt>
  <dd>Can this be deligated to someone. If so, change the reminder type to <code>~</code> (task) and set the <em>category</em> <code>@c waiting</code> and, perhaps, add the name of the person to whom the task was assigned to the <em>details</em>, <code>@d</code>. </dd>

  <dt>defer it - calendar</dt>
  <dd>Should this be deferred to a specific date in the future? If so, change the reminder type to <code>~</code> (task), change the due datetime in <code>@s</code> and set the <em>context</em> to <code>@c scheduled</code>. </dd>

  <dt>defer it - next and friends</dt>
  <dd>At this point we have a task that takes a single step to complete, takes more than two minutes to complete, couldn't be deligated and shouldn't be scheduled for some future date. Deferred to the next available opportunity for completion. This is the meaning of the category <em>next</em> but other categories might similarly call for "next available opportunity" completion but add further specficity. In each case, the reminder type should be changed to <code>~</code> (task), the <em>scheduled</em> <code>@s</code> entry should be removed and the <em>category</em> should be set to <code>@c next</code> or some variant. Here are a few illustrative variants: 

    <dl>
      
      <dt><code>@c home</code></dt>
      <dd>A next task best completed at "home".
      </dd>

      <dt><code>@c office</code></dt>
      <dd>A next task best completed at "office".</dd>

      <dt><code>@c errands</code></dt>
      <dd>A next task best completed when running "errands".</dd>

      <dt><code>@c email</code></dt>
      <dd>A next task best completed when doing "email".</dd>

    </dl>

  </dd>

</dl>

</div>
<div style="clear: both;"></div>


[↩︎](#table-of-contents)


### 1.8. GTD and Task View

<p><em>Task View</em> is designed specifically with <em>GTD</em> in mind. It begins with a tagged list of relevant <em>contexts</em> (those having at least one applicable reminder), each followed by its reminder count in parentheses. Tasks with <code>@c</code> are grouped under that context; tasks without <code>@c</code> but with <code>@s</code> are grouped under the implicit context <em>scheduled</em>; tasks with neither <code>@c</code> nor <code>@s</code> are grouped under the implicit context <em>inbox</em>. Jots (<code>-</code>) with neither <code>@e</code> nor <code>@u</code> are also grouped under <em>inbox</em>. The context order is <em>inbox</em>, <em>waiting</em>, <em>next</em>, other contexts alphabetically, then <em>someday</em> and <em>scheduled</em>. Pressing a context tag opens the corresponding tagged reminder list; pressing a reminder tag opens its details.
</p>


[↩︎](#table-of-contents)


### 1.9. Bins and Hash-Tags Views: Organizing your reminders

*Tklr* provides two complementary methods for organizing your reminders:

<ol>
  <li>Using the attribute <code>@b</code> to attach the the name of a bin to a reminder and the related <em>Bins View</em></li>
  <li>Using a <em>hash-tag</em>, i.e., <code>&#x23;</code> followed without spaces by an arbitrary word, in either the <em>subject</em> or the <em>details</em> attribute of reminders and the related <em>Tags View</em></li>
</ol>


#### 1.9.1 Bins View

The _Bins View_ displays a hierarchical, tree view of _bins_ and _reminders_.

Think of _bins_ as directories, _reminders_ as files and _Bin View_ as a file browser. The main difference is that _reminders_ can belong to more than one _bin_ or to none at all.

As an illustration of the power of being able to place a reminder in many bins consider a note describing a visit to Lille, France on November 11, 2025 which involved meeting a dear friend, Mary Smith for lunch. This note might belong to all of these bins:

- _travel_ (in _activities_)
- _2025:11_ (in _journal_)
- _Mary Smith_ (in _people:S_)
- _Lille_ (in _places:France_)

Many note taking applications provide a means for establishing links between notes. The terms _Zettelkasten_ and _Second Brain_ come to mind. A different approach is taken in _tklr_ where _bins_ serve as containers for both reminders and other bins. While a system of links between reminders might be broken by the removal of a reminder, when a reminder is removed from _tklr_, it simply disappears from the relevant bin membership lists. Bins themselves and their membership lists are otherwise unaffected.

<div style="overflow: auto;">
  <img src="https://raw.githubusercontent.com/dagraham/tklr-dgraham/master/screenshots/bin_root_screenshot.svg"
alt="Description" style="float: right; margin-left: 20px; width: 460px; margin-bottom: 10px;">

  <p>These are the important facts about <em>Bins</em>:
  </p>

  <ul>
    <li>Bin names are unique</li>
    <li>A bin can contain many other bins (children)</li>
    <li>A bin can belong to at most one other bin (parent)</li>
    <li>A reminder can belong to one or more bins by adding an <code>@b NAME</code> attribute with a unique <em>NAME</em> for each</li>
  </ul>

  <p>This is the opening, root level in <em>Bins view</em>.
  </p>
</div>

<div style="clear: both;"></div>

<div style="overflow: auto;">
  <img src="https://raw.githubusercontent.com/dagraham/tklr-dgraham/master/screenshots/bin_library_screenshot.svg"
alt="Description" style="float: right; margin-left: 20px; width: 460px; margin-bottom: 10px;">

  <p>Press <em>c</em> to open the <em>library</em> bin with its tagged list of children which now includes both bins and reminders.
  </p>

  <ul>
    <li>Use the tag for a bin to open the bin </li>
    <li>Use the tag for a reminder to display the details of the reminder</li>
    <li>Use tag <em>0</em>, <em>root</em>,in the <em>bread crumb trail</em> to go up to that bin</li>
  </ul>
</div>
<div style="clear: both;"></div>


<div style="overflow: auto;">
  <img src="https://raw.githubusercontent.com/dagraham/tklr-dgraham/master/screenshots/bin_quotations_screenshot.svg"
alt="Description" style="float: right; margin-left: 20px; width: 460px; margin-bottom: 10px;">

  <p>Press <em>e</em> to open the <em>quotations</em> bin with its tagged list of children which now includes only reminders.
  </p>
  <ul>
    <li>Use the tag for a reminder to display the details of the reminder</li>
    <li>Use tag <em>1</em>, <em>library</em>, in the <em>bread crumb trail</em> to go up to that bin</li>
    <li>Use tag <em>0</em>, <em>root</em>, in the <em>bread crumb trail</em> to go up to that bin</li>
  </ul>

</div>
<div style="clear: both;"></div>


#### 1.9.2 Hash-Tags View

<div style="overflow: auto;">
  <img src="https://raw.githubusercontent.com/dagraham/tklr-dgraham/master/screenshots/tags_screenshot.svg"
alt="Description" style="float: right; margin-left: 20px; width: 460px; margin-bottom: 10px;">

  <p>Press <em>T</em> to open the <em>Tags View</em> which lists reminders with <em>hash-tag</em> entries grouped by the <em>tag name</em>.
  </p>

</div>
<div style="clear: both;"></div>

[↩︎](#table-of-contents)


### 1.10. Query and Find Views: Where's Waldo

What is the name of that plumber we used and liked so much?

<div style="overflow: auto;">
  <img src="https://raw.githubusercontent.com/dagraham/tklr-dgraham/master/screenshots/query_screenshot.svg"
alt="Description" style="float: right; margin-left: 20px; width: 460px; margin-bottom: 10px;">
  <p>Just press <code>Q</code> to open the <em>Query View</em>, enter your query at the prompt and press <code>Enter</code>.
  </p>
  <p>This query asks for reminders that <em>include</em> in their <em>subject</em> or their <em>details</em> a match for <em>plumber</em> and found one matching reminder.
  </p>
  <p>The key corresponding to the tag, <code>a</code>, was pressed to display the details of the match.  Note that <em>Plumber</em> is in the details and was matched despite being capitalized.
  </p>

</div>
<div style="clear: both;"></div>

<div style="overflow: auto;">
  <img src="https://raw.githubusercontent.com/dagraham/tklr-dgraham/master/screenshots/query_exists_screenshot.svg"
alt="Description" style="float: right; margin-left: 20px; width: 460px; margin-bottom: 10px;">
  <p>Here the query asks for reminders that pass the <em>exists</em> test for the attribute <em>r</em>, i.e., for all reminders with an <code>@r</code> attribute.
  </p>
</div>
<div style="clear: both;"></div>


<div style="overflow: auto;">
  <img src="https://raw.githubusercontent.com/dagraham/tklr-dgraham/master/screenshots/query_help_screenshot.svg"
alt="Description" style="float: right; margin-left: 20px; width: 460px; margin-bottom: 10px;">
  <p>Press <code>?</code> to display the <em>help</em> information for <em>queries</em>.
  </p>


</div>
<div style="clear: both;"></div>

**Find View**. Looking for a case-insensitive match for a word in either the *subject* or the *details* of a reminder is such a common need that *tklr* provides a short-cut for this query - *Find View*. Instead of pressing `Q` and entering 

`includes subject d plumber`

you can press `F` to open the prompt for *Find View* and just enter 

`plumber`

What happens here?

And here?

[↩︎](#table-of-contents)


### 1.11. SQLite3 Data Store

SQLite offers tangible advantages over TinyDB’s JSON store which - used for *tklr*'s predecessor - especially at the required scale. The embedded SQL engine keeps queries fast even as data grows, thanks to indexed storage and compiled query plans rather than repeatedly parsing whole JSON file. Reliability improves because SQLite wraps writes in ACID transactions so crashes or concurrent edits won’t corrupt the data, whereas TinyDB depends on rewriting the JSON blob. Finally, SQLite’s standard file format means other tools (command-line clients, BI dashboards, scripting languages) can open the same .db directly or even run read-only analytics in parallel, something that’s awkward with a bespoke JSON structure.


[↩︎](#table-of-contents)


## 2. Details

### 2.1. DateTimes

Intelligent parsing of the user's entry of a datetime is supported. Suppose it is 10am on Thursday, November 6 2025 in the US/Eastern timezone. When a datetime is entered it is interpreted _relative_ to the current date, time and timezone. When entering the scheduled datetime for a reminder using `@s`, the following table illustrates how various entries would be interpreted and the resulting user feedback.

| @s entry        | interpretation       | user feedback              |
| --------------- | -------------------- | -------------------------- |
| wed             | 2025-11-12           | Wed, Nov 12 2025           |
| now             | 2025-11-06 10:00 EST | Thu, Nov 6 2025 10:00 EST  |
| today           | 2025-11-06           | Thu, Nov 6 2025            |
| 9a              | 2025-11-06 09:00 EST | Thu, Nov 6 2025 09:00 EST  |
| 9a fri          | 2025-11-07 09:00 EST | Fri, Nov 7 2025 09:00 EST  |
| 10 9p z none    | 2025-11-10 21:00     | Mon, Nov 10 2025 21:00     |
| 3p z US/Pacific | 2025-11-06 18:00 EST | Thu, Nov 6 2025 18:00 EST  |
| 10 13:30 z CET  | 2025-11-10 07:30 EST | Mon, Nov 10 2025 07:30 EST |
| 10 20h z none   | 2025-11-23 20:00     | Mon, Nov 10 2025 20:00     |

Datetimes entered with "z none" and dates are _naive_ - have no timezone information. Datetimes entered with "z TIMEZONE" are interpreted as _aware_ datetimes in TIMEZONE. Datetimes without a "z" entry are also interpreted as _aware_ but in the timezone of the user's computer. Aware datetimes are always reported using the timezone of the user's computer, wherever it might be. Times can be entered using the suffix of either a/p or am/pm for AM/PM times or h for 24-hour times. Times are reported using the preference of the user, here as 24-hour times.

Why would you want to use a "z" in specifying a time? Suppose a colleague in Europe at asked you to call Friday at 18:00 CET time. Then setting "@s fri 18h z CET" will schedule your reminder for the correct time to call wherever you might be. In the US/Eastern timezone, this would be "Fri, Nov 12 2025 12:00 EST". As a second example, suppose you want to take a daily medication at 4pm in whatever timezone you happen to be. Then you will want to schedule the reminder for "@s 4p z none".

When dates and datetimes are recorded, _aware_ datetimes are first converted to UTC time and then stored with a "Z" appended. E.g., the "3p z US/Pacific" datetime would be interpreted as "2025-11-06 18:00 EST" but would be recorded as "20251106T2300Z". Dates and _naive_ datetimes are recorded without conversion and without the trailing "Z". When _aware_ datetimes are displayed to the user, they are first converted to the timezone of the user's computer. Thus the "PST" example would be displayed as scheduled for 6pm today in US/Eastern. Dates and _naive_ datetimes are displayed without change in every timezone.

When an `@s` scheduled entry specifies a date without a time, i.e., a date instead of a datetime, the interpretation is that the task is due sometime on that day. Specifically, it is not due until `00:00` on that day and not past due until `00:00` on the following day. The interpretation of `@b` and `@u` in this circumstance is similar. For example, if `@s 2025-04-06` is specified with `@b 3d` and `@u 2d` then the task status would change from waiting to pending at `2025-04-03 00:00` and, if not completed, to deleted at `2025-04-09 00:00`.

Note that times can only be specified, stored and displayed in hours and minutes - seconds and microseconds are not supported. Internally datetimes are interpreted as having seconds equal to 0.

The `dayfirst` and `yearfirst` settings in `config.toml` are used to resolve ambiguous date entries involving 2-digit components. E.g., the interpretation of the date "12-10-11" with the various possible settings for dayfirst and yearfirst:

| dayfirst | yearfirst | date     | interpretation | standard       |
| -------- | --------- | -------- | -------------- | -------------- |
| True     | True      | 12-10-11 | 2012-11-10     | Y-D-M ??       |
| True     | False     | 12-10-11 | 2011-10-12     | D-M-Y EU       |
| False    | True      | 12-10-11 | 2012-10-11     | Y-M-D ISO 8601 |
| False    | False     | 12-10-11 | 2011-12-10     | M-D-Y US       |

The defaults: dayfirst = false and yearfirst = true correspond to the Y-M-D ISO 8601 standard. 

A related setting `ampm` 


[↩︎](#table-of-contents)

### 2.2. TimeDeltas

An <em>timedelta</em> is just a period of time and is entered in _tklr_ using expressions such as

| entry | period of time          |
| ----- | ----------------------- |
| 2h    | 2 hours                 |
| -2h   | - 2 hours               |
| 1w7d  | 1 week and 7 days       |
| 2h30m | 2 hours and 30 minutes  |
| 1m27s | 1 minute and 27 seconds |

Note that w (weeks), d (days), h (hours), m (minutes) and s (seconds) are the available _units_ for entering _intervals_. Seconds are ignored save for their use in alerts - more on alerts later.

<em>Arithmetic</em>. A timedelta, `D`, can be added to a datetime, `T`, to get a datetime, `T + D`, that will be after `T` if `D > 0` and before `T` if `D < 0`. Similarly, one datetime, `A`, can be subtracted from another, `B`, to get a timedelta, `T = B - A`, with `T > 0` if `B` is after (greater than) `A` and `T < 0` if `B` is before (less than) `A`.

One example of this arithmetic is that an event with `@s 10a fri @e 1h30m` will span the period <em>10:00 - 11:30</em> on Friday, the ending datetime corresponding to the sum of the <em>scheduled</em> datetime and the <em>extent</em> timedelta.

[↩︎](#table-of-contents)

### 2.3. Scheduled datetime

For the discussion that follows, it will be assumed that the current date is `2025-10-01` and that the _scheduled datetime_ for the illustrative reminder is

    @s 2025-10-21 10:00am

[↩︎](#table-of-contents)

### 2.4. Extent timedelta

The entry `@e 2h30m` would set the _extent_ for the reminder to two hours and 30 minutes.

If the reminder were an _event_, this would schedule the "busy time" for the event to _extend_ from 10am until 12:30pm.

For a task, this same entry would indicate that attention to completing the task should begin no later than 10am and that 2 hours and 30 minutes is the _estimate_ of the time required for completion. The period from 10am until 12:30pm is not displayed as a busy time, however, since the task could be begun before or after 10am and could take more or less than 2 hours and 30 minutes to complete. For a task, both `@s` and `@e` are best regarded as _estimates_.

For a project, this same entry would similarly indicate that attention to completing the project should begin no later than 10am and that two hours and 30 minutes is estimated for completion subject to additional times specified in the jobs. A job entry containing `&s 2d &e 3h`, for example, would set the scheduled time for this job to be two days _after_ the `@s` entry for the project and would add three hours to the estimate of total time required for the project.

[↩︎](#table-of-contents)

### 2.5. Notice timedelta

The entry `@n XYZ` where `XYZ` is a _positive_ timedelta specifies that a notice for the reminder should begin to be *noticed* on the date in which `scheduled - XYZ` falls. For the example, adding `@n 1d12h` would cause the reminder to be *noticed* beginning on

      2025-10-21 10am - 1d12h = 2025-10-19 10pm

If the reminder is an event, then the agenda view would display an notice for the event beginning on `25-10-19` and continuing on the `25-10-20`, i.e., from the date of the notice through the date before the scheduled datetime. For an _event_ think of this notice as a visual alert of the proximity of the event.

If the reminder is a task, then the task would _not_ appear in the agenda view until `25-10-19`, i.e., it would be hidden before that date.

[↩︎](#table-of-contents)

### 2.6. Wrap

The entry `@w BEFORE, AFTER`, where `BEFORE` and `AFTER` are _timedeltas_, can be used to wrap the _scheduled_ datetime of a reminder. Possible entries and the resulting values of BEFORE and AFTER are illustrated below:

| wrap       | before | after      |
| ---------- | ------ | ---------- |
| @w 1h, 30m | 1 hour | 30 minutes |
| @w 1h,     | 1 hour | None       |
| @w , 30m   | None   | 30 minutes |

Consider an event with `@s 2025-10-21 10am @e 2h30m`, which starts at 10am and ends at 12:30pm and suppose that it will take an hour to travel to the location of the event and 30 minutes to travel from the event to the next location. The entry `@w 1h, 30m` could be used to indicate these travel periods from 9am until 10am before the event begins and from 12:30pm until 1pm after the event ends. The event will be displayed with its actual starting and ending times but the entire period including the <em>wrap</em> will be treated as <em>busy</em>.

[↩︎](#table-of-contents)

### 2.7. Alert

An alert is specified using `@a <list of intervals> : <list of commands>`. An `@s <datetime>` is required and the result is to execute the commands in `<list of commands>` at the datetimes resulting from subtracting the intervals in `<list of intervals>` from `<datetime>`. E.g., with `@s 17:00 fri` and `@a 1h, -15m: n, v`, the commands `n` and `v` would each be executed at `17:00 - 1h = 16:00` and `17:00 + 15m = 17:15` on Friday.

The command `n` in the example is *built into tklr* - it sounds a bell and pops up a message on the *tklr* display which lasts for a minute (or until clicked on).  Other commands such as `v` in the example must be specified in the user configuration file. This is the relevant section:

```
[alerts]
# dict[str, str]: character -> command_str.
# E.g., this entry
#   v: '/usr/bin/say -v Alex "[[volm 0.5]] {subject}, {when}"'
# would, on my macbook, invoke the system voice to speak the subject
# of the reminder and the time remaining until the scheduled datetime.
# The character "v" would be associated with this command so that, e.g.,
# the alert entry "@a 30m, 15m: v" would trigger this command 30
# minutes before and again 15 minutes before the scheduled datetime.
```

[↩︎](#table-of-contents)

### 2.8. Recurrence

#### 2.8.1. When @r and, by requirement, @s are given

When an item is specified with an `@r` entry, an `@s` entry is required and is used as the `DTSTART` entry in the recurrence rule. E.g.,

```
* datetime repeating @s 2025-11-06 14:00 @r d &i 2
```

With this entry, the `@s 2025-11-06 14:00` and `@r d &i 2` parts would be combined by _tklr_ to generate this _rruleset_:

```
      "rruleset": "DTSTART:20251106T1900Z\nRRULE:FREQ=DAILY;INTERVAL=2"
```

Two aspects of this _rruleset_ are worth emphasizing

1. "DTSTART:20251106T1900Z\nRRULE:FREQ=DAILY;INTERVAL=2" is a string and can therefore be stored without conversion in SQLite3 - the database used for _tklr_.
2. Even though it is only 50 characters long, it actually represents an infinite number of datetimes - every datetime matching the recurrence rule which occurs on or after 2025-11-06 19:00 UTC.

In the hands of the wonderful _python_ library _dateutil_, this _rruleset_ string can be asked a variety of useful questions which will be answered almost instantly. E.g, What datetimes does it represent which lie between 2025-06-23 08:00 and 2026-01-01 00:00?, What is the first datetime after 2025-10-15 00:00? What is the last datetime before 2025-12-15 00:00? And so forth.

**For every reminder in tklr which involves datetimes, a rruleset is used to represent all of those datetimes.**

**Note**: The datetimes generated by the _rruleset_ correspond to datetimes matching the specification of `@r` which occur **on or after** the datetime specified by `@s`. **The datetime corresponding to `@s` itself will only be generated if it matches one of the instances generated by** `@r`.

#### 2.8.2. When @s is given but not @r

On the other hand, if an `@s` entry is specified, but `@r` is not, then the `@s` entry would be stored as an `RDATE` in the recurrence rule. E.g.,

```python
* datetime only @s 2025-11-06 14:00
```

would be serialized (stored) as

```
  "rruleset": "RDATE:20251106T1900Z"
```

The datetime corresponding to `@s` itself is, of course, generated in this case.

#### 2.8.3. When @+ is specified, with or without @r

When `@s` is specified, an `@+` entry can be used to specify one or more, comma separated datetimes. When `@r` is given, these datetimes are added to those generated by the `@r` specification. Otherwise, they are added to the datetime specified by `@s`. E.g., is a special case. It is used to specify a datetime that is relative to the current datetime. E.g.,

```
   ... @s 2025-11-06 14:00 @+ 2025-11-13 21:00
```

would be serialized (stored) as

```
  "rruleset": "RDATE:20251106T1900Z, 20251114T0200Z"
```

This option is particularly useful for irregular recurrences such as annual doctor visits. After the initial visit, subsequent visits can simply be added to the `@+` entry of the existing event once the new appointment is made.

**Note**: Without `@r`, the `@s` datetime is included in the datetimes generated but with `@r`, it is only used to set the beginning of the recurrence and otherwise ignored.

[↩︎](#table-of-contents)

### 2.9. Masked Information

A <code>@m</code> attribute can be used to record information in a reminder that will be stored in an obfuscated format. Only someone running <em>tklr</em> with the <em>secret</em> from the configuration file used to create the entry will see the clear value. Useful for passwords, account numbers, diary entries or whatever.

For example, this entry:

```
@m This is a masked entry - it should be readable in
the details view of the UI but otherwise obfuscated.
```

would be displayed in the SQLite3 database as

```
@m wrnClsOSwprDmMKKwrrDnGTDiGTCpsK0w5_CnMOPwq9twr3DlMOE
wrXDjMKDecKNw4_DqHHCqcOgw4jCp8Kuw45Rw4fDj3HDm8Kpw4jCqMK
awrXDmMKWworCtMK7eMOawrjCqHPDh8Kxw6HDh8Odwr3CqcKYw4_Cm8
Knw6FRw5TDkHHDncKsw4xkwo7CnMKMwpPDn8K_bcOHw5r CuMKow4XD
msK1w6DDi8KUw4DCmMOew47CpcKlw4vCpcOKw45_
```

[↩︎](#table-of-contents)

### 2.10. HashTags

A single word, without spaces, preceded by a hash character `#` and included in either the <em>subject</em> or the <em>details</em> (`@d` attribute) of a reminder is treated as a hashtag and displayed in <em>Tags View</em> under the tag. This provides a way to flag a word that would be included anyway. E.g., `@d A useful #python trick would be to ...`.

[↩︎](#table-of-contents)

### 2.11. Anniversaries

<div style="overflow:auto;">
  <pre style="float:right; margin-left:20px; width:460px; background:#111; color:#ddd; padding:12px; border-radius:6px;">
<code>* Max's {XXX} birthday
  @s 2016-10-23
  @r y &m 10 &d 23
</code>
  </pre>
  <p>Reminders that repeat using an <code>@r</code> attribute can automatically display the number of the anniversary. The <em>anniversary expression</em>, <code>{XXX}</code>, when placed in the <em>subject</em> will be replaced in the listing of the reminder in Agenda, Next and Weeks views by the relevant number of the anniversary. For example, in the listing for October 23, 2026, the subject of this reminder would appear as <code>Max's 10th birthday</code>. Note that the appropriate suffix from [st, nd, rd or th] is automatically applied and, because of the yearly frequency specified by <code>@r y</code>, the count represents the number of years separating the instance from the <em>scheduled</em> datetime.
  </p>
</div>
<div style="clear:both;"></div>


[↩︎](#table-of-contents)

### 2.12. Timezones

When a datetime is specified without an `z` component, the timezone is assumed to be aware and represented using the local timezone. The datetime is converted to UTC for storage in the database. When an aware datetime is displayed, it is displayed using the local timezone of the computer.

Suppose you're in the US/Eastern timezone and want to schedule a call to a friend at 3:00pm Friday, US/Pacific time. This could be entered as `@s 3p fri z US/Pacific`. This datetime would first be converted to UTC time and then stored as a string in the SQLite3 database. It would then be displayed to you in the local timezone of your computer, where ever it might be.

This remains true with _recurrence_ and _daylight savings time_ but is a little more complicated. As always, the recurrence rules are stored in UTC and the datetimes generated by the rules are also in UTC. When these datetimes are displayed, they are converted to the local timezone.

```
   ... @s 2025-10-31 14:00 @r d &i 1 &c 4
```

With this entry, the rruleset and datetimes generated show the effect of the transition from daylight to standard time:

```
"rruleset": "DTSTART:20251031T1800Z\nRRULE:FREQ=DAILY;INTERVAL=1;COUNT=4"

  Fri 2025-10-31 14:00 EDT -0400
  Sat 2025-11-01 14:00 EDT -0400
  Sun 2025-11-02 13:00 EST -0500
  Mon 2025-11-03 13:00 EST -0500
```

[↩︎](#table-of-contents)

### 2.13 Urgency

Every task carries an **urgency score** — a number from 0 to 100 that determines its rank in the Tasks section of the agenda. The score is computed from a small set of task attributes and a configurable model defined in `config.toml`.

#### The Formula

    urgency = 100 × (primary + secondary) / maximum_possible_urgency

The score has two independent parts: a **primary** component that captures the task's most pressing reason for attention, and a **secondary** component that accumulates smaller contextual signals. Both are normalized against the maximum achievable score so that 100 always means "as urgent as it gets."

---

#### Primary Component

The primary component reflects the single strongest reason a task needs attention. Only one signal wins — they do not add together.

**If the task has a due date:**

    primary = due + pastdue

The presence of a due date is a commitment — it trumps age and priority entirely, regardless of how far away the deadline is. A task due eleven months from now will not drift to the top of the list because it is getting old; it sits quietly with a low score until the due window opens, then rises as the deadline approaches.

- **due** ramps linearly from 0 up to `due.max` (default: 14) over the final `due.interval` (default: 7 days) before the deadline. A task due tomorrow scores near 14; one due in three weeks scores 0.
- **pastdue** adds on top once the deadline has passed, ramping from 0 to `pastdue.max` (default: 2) over `pastdue.interval` (default: 1 day). An overdue task can score up to 16 on the primary component alone.

**If the task has no due date:**

    primary = max(priority, age_recent)

The higher of explicit priority or inactivity pressure wins.

- **priority** is a fixed weight assigned by priority level: p1=16, p2=10, p3=4, p4=0, p5=−2. Negative weights are supported — a p5 task actively pulls urgency down.
- **recent** ramps from `recent.max` (default: 5) down to 0 over `recent.interval` (default: 6 days) since the task was last modified. A freshly touched task gets a short-lived boost that decays quickly.
- **age** ramps from 0 to `age.max` (default: 16) over `age.interval` (default: 96 days) since the task was last modified. A task that has gone untouched gradually rises in urgency — use the `touch` command to reset the clock.
- **age_recent = max(age, recent)** — together these two signals form a smooth curve: `recent` wins immediately after a touch, then fades; `age` takes over as the task goes stale.

---

#### Secondary Component

The secondary component accumulates smaller signals that enrich the score without dominating it. All of them add together:

    secondary = tags + description + extent + blocking + project

| Signal | What it measures | Default max |
|---|---|---|
| **tags** | Number of tags, proportional up to a count threshold | 2 |
| **description** | Whether a description is present (flat bonus) | 2 |
| **extent** | Scheduled duration, proportional up to a time threshold | 2 |
| **blocking** | Number of other tasks this one is blocking | 2 |
| **project** | Whether the task has sub-tasks (jobs) | 2 |

With default settings, secondary can add at most 10 to the raw score.

---

#### Normalization

The maximum raw score is:

    maximum_possible_urgency = primary_max + secondary_max = 16 + 10 = 26

Dividing by 26 and multiplying by 100 maps every task onto a 0–100 scale. A pinned task bypasses the formula entirely and is always displayed at 100.

---

#### Configuring the Model

All weights, maxima, and intervals are set in `config.toml` under the `[urgency]` section. Run `tklr urgency-report` to see the current settings, the computed maxima, and a per-task breakdown showing exactly which components drove each score.


[↩︎](#table-of-contents)

### 2.14. Priority

How is *priority* calculated for *goals*?  Consider a goal a goal with the target `@t n/t` so that `n` is the number of completions intended for the period `t`. Suppose further that `n'` is the number of instances remaining to be completed this period and that `t'` is the time remaining in the period for their completion.

Now consider these possibilities:

- `n'/t' > n/t`:
    the needed completion rate has increased - completions are *behind* schedule
- `n'/t' = n/t`:
    the needed completion rate is unchanged - completions are *on* schedule
- `n'/t' < n/t`:
    the needed completion rate has decreased - completions are *ahead* of schedule

If <em>priority</em> is defined by ratio
```
  priority = 100 * (n' * t) / (n * t')
```
then it indicates the completion rate currently needed as a percentage of the original rate and the possibilities can be stated as:

- `priority > 100`: behind schedule.
- `priority = 100`: on schedule.
- `priority < 100`: ahead of schedule.

[↩︎](#table-of-contents)

### 2.15. Open with default

An <code>@g</code> attribute can be used to enter a URL, file or whatever which can the be "opened" using your system default application by selecting the item and using the menu command "Open with default". Example entries:

- URL: <code>@g https://dagraham.github.io/tklr-dgraham/</code>
  Open the URL in the default browser.
- Mail: <code>@g mailto:dnlgrhm@gmail.com</code>
  Open a new email to the provided address using the default email agent.
- File: <code>@g ~/Projects/tklr-uv/README.md</code>
  Open the markdown file using the system default agent for markdown files. (<em>Marked 2</em>?)
- File: <code>@g ~/Projects/tklr-uv/make_items.py</code>
  Open the python file using the system default agent for <code>.py</code> files. (<em>Neovide</em>?)
- File: <code>@g ~/Projects/tklr-uv/items/tklr.db</code>
  Open the SQLite3 file using the system default agent for <code>.db</code> files. (<em>SQLPro Studio</em>?)
- File: <code>@g ~/Projects/tklr-uv/mouse_with_watch.png</code>
  Open the image file using the system default agent for <code>.png</code> files. (<em>Preview</em>?)

Maybe an event involves a zoom meeting? Add an <code>@g</code> attribute with the URL for the meeting.

[↩︎](#table-of-contents)

### 2.16. Away from your computer? Use the cloud

There are two ways in which *tklr* supports remote usage through the the <em>cloud</em>. The examples here involve the use of <em>iCloud</em>, an <em>iPhone</em> and an <em>iPhone</em> app called <em>Textastic</em>, but these are just examples and a similar setup could be made using, e.g., <em>Google Drive</em>. All that's needed is a link to the <em>tklr</em> home directory in your cloud and a plain text / code editor on your mobile device which can access the linked directory.

#### 2.16.1. To access to your schedule

With this entry in <em>config.toml</em> in your home directory:

<code>current_command = "!tklr agenda --width 46"</code>

<em>tklr</em> will automatically output the result of the <code>agenda</code> command to the file <em>current.txt</em> in your home directory, creating the file if necessary and otherwise overwriting it whenever it needs to be updated. With a link to your home directory in <em>iCloud</em>, your agenda, trimmed to 46 characters to fit comfortably on your <em>iPhone</em> screen in portrait mode, will always be available to you. The same approach could be used with <code>weeks</code>, <code>days</code> or any other <em>tklr</em> command. The application <em>Textastic</em> is ideal for displaying the monospaced output and works well with <em>iCloud</em> files.

#### 2.16.2. To record reminders

The key here is parallel file, <em>inbox.txt</em>, in your home directory. Normally this file has zero length, but if you edit it using, say, <em>Textastic</em> and record one or more reminders using exactly the same format that you would use with <em>tklr</em> and being careful to leave a blank line between reminders, then the next time <em>tklr</em> checks the length of this file and notices that it is greater than zero, it will import each of the reminders.  

As they are imported, reminder types other than <em>jots</em> are recorded with a <code>?</code> prefix to be treated as <em>draft</em> reminders until you later remove the <code>?</code> prefix. <em>Jots</em>, on the other hand, are recorded without this <code>?</code> prefix but with a timestamp if an `@s` entry is not already provided. 

Reminders are automatically removed from <em>inbox.txt</em> as they are imported so that the length of this file will be restored to zero and ready for subsequent additions. When you next open <em>tklr</em>, all the "drafts" will be listed together on the current day of the events listing in <em>Agenda View</em> ready for you to make any edits you like to the "drafts" and remove the <code>?</code> prefixes. The <em>jots</em> will be listed in <em>Jots View</em>.

### 2.17. Palette View: Customizing Theme Color Settings

The purpose of <em>Palette View</em> is to display the color settings that are available for user customization in <code>config.toml</code> along with the palette of colors available for use in those settings.

<div style="overflow: auto;">
  <img src="https://raw.githubusercontent.com/dagraham/tklr-dgraham/master/screenshots/palette_settings_single.svg" alt="Description" style="float: right; margin-left: 20px; width: 460px; margin-bottom: 10px;">
  <p>The opening view shows the current color settings for the currently selected <em>theme</em> which, in this case, is the <em>dark</em> theme.
  </p>
</div>
<div style="clear: both;"></div>

<div style="overflow: auto;">
  <img src="https://raw.githubusercontent.com/dagraham/tklr-dgraham/master/screenshots/palette_settings_dual.svg" alt="Description" style="float: right; margin-left: 20px; width: 460px; margin-bottom: 10px;">
  <p>Pressing "p" toggles a dual display for both of the available themes with <em>dark</em> on the left and <em>light</em> on the right. In both cases, the colors reflect the current settings which, in the absence of customizations, are just the default settings for the two themes.
  </p>
</div>
<div style="clear: both;"></div>

<div style="overflow: auto;">
  <img src="https://raw.githubusercontent.com/dagraham/tklr-dgraham/master/screenshots/palette_colors_dual.svg" alt="Description" style="float: right; margin-left: 20px; width: 460px; margin-bottom: 10px;">
  <p>Pressing "c" toggles the display to show a list of the named colors against the backgrounds currently used for the <em>dark</em> and <em>light</em> themes.
  </p>
  <p>The color for a setting can be customized in <code>config.toml</code> by first noting the theme in this section
  </p>
<pre>
  [ui]
  theme = "dark"
</pre>
<p>

Then, for example, replacing this commented out section
</p>

<pre>
  # [ui.palette.dark]
  # header_color = "#1f4b7a"
  # jot_full = "#040405"
</pre>

<p>
with
</p>

<pre>
  [ui.palette.dark]
  task_color = "dodgerblue"
</pre>

<p>
would change the color for the <em>task</em> type for the current <em>dark</em> setting from "lightskyblue" to "dodgerblue". Note that either the color name or the hex value can be used.
</p>

</div>
<div style="clear: both;"></div>

### 2.18. Token Keys 

The table below gives the complete list of both `@-keys` and, when applicable, their `&-key` attributes.  It is generated from the source code automatically so it is always up to date.

<!-- BEGIN TOKEN KEYS -->

| key     | name                           | allowed                | required | requires | multiple |
| ------- | ------------------------------ | ---------------------- | -------- | -------- | -------- |
| `@+`    | rdate                          | *, ~, ^, %, x, ?       |          | `@s`     | no       |
| `@-`    | exdate                         | *, ~, ^, %, x, ?       |          | `@r`     | no       |
| `@a`    | alerts                         | *, ~, ^, %, x, ?       |          | `@s`     | yes      |
| `@b`    | bin                            | *, ~, ^, %, !, x, ?    |          |          | yes      |
| `@c`    | context                        | *, ~, ^, %, !, x, ?    |          |          | no       |
| `@d`    | details                        | *, ~, ^, %, !, -, x, ? |          |          | no       |
| `@e`    | extent                         | *, ~, ^, %, -, x, ?    |          |          | no       |
| `@f`    | finish                         | ~, ^, !, x, ?          |          |          | no       |
| `@g`    | goto                           | *, ~, ^, %, !, x, ?    |          |          | no       |
| `@i`    | invitees                       | *, ?                   |          |          | no       |
| `@k`    | kompletions                    | !, ?                   |          |          | no       |
| `@l`    | label                          | *, ~, ^, %, !, x, ?    |          |          | no       |
| `@m`    | mask                           | *, ~, ^, %, !, x, ?    |          |          | no       |
| `@n`    | notice                         | *, ~, ^, %, !, x, ?    |          | `@s`     | no       |
| `@o`    | offset                         | *, ~, ^, x, ?          |          | `@s`     | no       |
| `@p`    | priority                       | ~, ^, x, ?             |          |          | no       |
| `@r`    | recurrence                     | *, ~, ^, x, ?          |          | `@s`     | yes      |
| `@r &E` | easterdays                     | *, ~, ^, x, ?          |          |          | no       |
| `@r &H` | hours                          | *, ~, ^, x, ?          |          |          | no       |
| `@r &M` | minutes                        | *, ~, ^, x, ?          |          |          | no       |
| `@r &W` | week numbers                   | *, ~, ^, x, ?          |          |          | no       |
| `@r &c` | count                          | *, ~, ^, x, ?          |          |          | no       |
| `@r &d` | monthdays                      | *, ~, ^, x, ?          |          |          | no       |
| `@r &i` | interval                       | *, ~, ^, x, ?          |          |          | no       |
| `@r &m` | months                         | *, ~, ^, x, ?          |          |          | no       |
| `@r &s` | set positions                  | *, ~, ^, x, ?          |          |          | no       |
| `@r &u` | until                          | *, ~, ^, x, ?          |          |          | no       |
| `@r &w` | weekdays                       | *, ~, ^, x, ?          |          |          | no       |
| `@s`    | scheduled                      | *, ~, ^, %, !, -, x, ? | *, !     |          | no       |
| `@t`    | target                         | !, ?                   | !        |          | no       |
| `@u`    | use                            | -, ?                   |          |          | no       |
| `@w`    | wrap                           | *, ~, ^, %, x, ?       |          |          | no       |
| `@~`    | job                            | ^, x, ?                | ^        |          | yes      |
| `@~ &a` | alert                          | ^, ?                   |          | `@s`     | yes      |
| `@~ &c` | context                        | ^, ?                   |          |          | no       |
| `@~ &d` | details                        | ^, ?                   |          |          | no       |
| `@~ &e` | extent                         | ^, ?                   |          |          | no       |
| `@~ &f` | finish                         | ^, ?                   |          |          | no       |
| `@~ &i` | unique id                      | ^, ?                   |          |          | no       |
| `@~ &l` | label                          | ^, ?                   |          |          | no       |
| `@~ &m` | mask                           | ^, ?                   |          |          | no       |
| `@~ &r` | id and list of requirement ids | ^, ?                   |          |          | yes      |
| `@~ &s` | scheduled                      | ^, ?                   |          | `@s`     | no       |

<!-- END TOKEN KEYS -->


[↩︎](#table-of-contents)

## 3. Getting Started

### 3.1. Installing _tklr_

As a standalone command-line application, <em>tklr</em> is best installed from <em>PyPI</em> using <code>pipx</code>. Before installing, check which version of <code>python3</code> you already have:
```
python3 --version
```

On some Linux distributions, the system <em>python</em> installation is managed by the operating system and protected from direct <code>pip</code> installs. This helps prevent conflicts with distro-managed <em>python</em> packages that the OS itself may depend on. <code>pipx</code> avoids these issues by installing each application in its own isolated environment while still making the <code>tklr</code> command available in your shell.

If <code>python3 --version</code> reports Python 3.12 or newer, install <em>tklr</em> with:
```
pipx install --python python3 tklr-dgraham
```

To upgrade an existing installation:
```
pipx upgrade tklr-dgraham
```

<em>Tklr</em> requires Python 3.12 or newer. If <code>python3 --version</code> reports an older version, first install a newer Python and then tell <code>pipx</code> explicitly which Python 3.12+ interpreter to use. For example, if you use <code>pyenv</code>:
```
pipx install --python ~/.pyenv/versions/3.13.0/bin/python tklr-dgraham
```

### 3.2 Starting tklr for the first time

**Tklr** needs a _home_ directory to store its files, most importantly these two:

- _config.toml_: An editable file that holds user configuration settings
- _tklr.db_: An _SQLite3_ database file that holds all the records for events, tasks and other reminders created when using _tklr_

Any directory can be used for _home_. These are the options:

1. If started using the command `tklr --home <path_to_home>`, tklr will use that directory. If it does not exist, you will be prompted to create it. The files `config.toml` and `tklr.db` will be created there if needed.
2. If the `--home <path_to_home>` is not passed to _tklr_ then the _home_ will be selected in this order:

   - If the current working directory contains files named `config.toml` and `tklr.db`, it will be used as _home_.
   - Else if the environment variable `TKLR_HOME` is set, it will be used as _home_ (and created if missing).
   - Else if the environment variable `XDG_CONFIG_HOME` is set, `${XDG_CONFIG_HOME}/tklr` will be used (and created if missing).
   - Else the directory `~/.config/tklr` will be used (and created if missing).

### 3.3. Configuration

The default settings are in _config.toml_ in your _tklr_ home directory together with detailed explanations for each setting.

[↩︎](#table-of-contents)

## 4. Using the Command Line Interface

<div style="overflow:auto;">
  <pre style="float:right; margin-left:20px; width:460px; background:#111; color:#ddd; padding:12px; border-radius:6px;">
<code>% tklr --help
Usage: tklr [OPTIONS] COMMAND [ARGS]...

  Tklr CLI – manage your reminders from the command
  line.

Options:
  --version      Show the version and exit.
  --home TEXT    Override the Tklr workspace directory
                 (equivalent to setting $TKLR_HOME).
  -v, --verbose  Enable verbose output
  --help         Show this message and exit.

Commands:
  add
  agenda   Display the current agenda: events for...
  alerts   List alerts scheduled for the rest of...
  check    Check whether an entry is valid...
  days     days(start: date = today(), end:...
  details  Display the details for a reminder...
  find     Search reminders whose subject or @d...
  finish   Mark a reminder finished, providing...
  migrate  Convert ETM reminders into a Tklr...
  query    Run an advanced query and list...
  ui       Launch the Tklr Textual interface.
  weeks    weeks(start: date = today(), end:...
</code>
</pre>

<p>Here is the main <em>tklr</em> help message. All the <em>Commands</em> other than <code>ui</code> belong to the CLI.
</p>
</div>
<div style="clear:both;"></div>


<div style="overflow:auto;">
  <pre style="float:right; margin-left:20px; width:460px; background:#111; color:#ddd; padding:12px; border-radius:6px;">
<code>% tklr agenda --help
Usage: tklr agenda [OPTIONS]

  Display the current agenda: events for the next 3
  days with drafts and notices along with tasks
  ordered by urgency.

  Examples:   tklr agenda   tklr agenda --width 60
  tklr agenda --rich

Options:
  --width INTEGER RANGE  Maximum line width (good
                         for small screens).
  --rich                 Use Rich colors/styling
                         (default output is plain).
  --ids                  Append record ids in
                         parentheses for each
                         reminder row.
  --help                 Show this message and exit.
</code>
</pre>

<p>For the help information on a particular command, enter the name of the command and then append <code>--help</code>. E.g., here is the help for the <em>agenda</em> command.
</p>
</div>
<div style="clear:both;"></div>

<div style="overflow: auto;">
  <img src="https://raw.githubusercontent.com/dagraham/tklr-dgraham/master/screenshots/agenda_rich.png"
alt="Description" style="float: right; margin-left: 20px; width: 460px; margin-bottom: 10px;">
  <p>The <code>--rich</code> option is probably the least apparent. Using it adds <em>rich</em> colors to the format of the display. Here are examples of <em>agenda</em> with and without this argument.
  </p>
</div>
<div style="clear: both;"></div>


[↩︎](#table-of-contents)

## 5. Coming from <em>etm</em>

The basic entry format is essentially the same in *tklr* as it was in *etm*. There are a few changes to reminder types, attributes (specified with <code>@-keys</code>) and their modifiers (specified with <code>&-keys</code>) - these are documented below.

### 5.1 Datetime entry and <code>@z</code>

The attribute <code>@z</code> to specify the timezone for datetime entries in a reminder is no longer supported. The same purpose is now achieved by appending <code>z TIMEZONE</code> to the scheduled datetime attribute. E.g.,

<code>@s 9a fri z US/Pacific</code>

would indicate that "9a fri" is to be interpreted as an <em>aware</em> datetime in the "US/Pacific" timezone. Similarly <code>z none</code> would indicate that the preceding datetime is to be interpreted as a <em>naive</em> datetime.

### 5.2. Type Changes

|    etm    |   tklr    |
| :-------: | :-------: |
|  * event  | unchanged |
|  - task   |  ~ task   |
|  ~ goal   |  ! goal   |
|  ! inbox  |  ? draft  |
| - project | ^ project |
| % journal |  % note   |


### 5.3. Attribute Changes

|     etm     |         tklr          |
| :---------: | :-------------------: |
| @b beginby  |       @n notify       |
| @c calendar |                       |
|  @i index   |        @b bin         |
|   @j job    |   @~ task (project)   |
| @k connect  |                       |
|             | @k completions (goal) |
| @n attendee |                       |
|   @t tag    |       #hashtag        |
|             |   @t target (goal)    |

### 5.4. <code>@r</code> modifier changes

|     etm      |     tklr     |
| :----------: | :----------: |
|   &h hours   |   &H hours   |
|  &n minutes  |  &M minutes  |
|  &M months   |  &m months   |
| &m monthdays | &d monthdays |

These *tklr* settings mirror standard usage in <code>strftime</code>.

### 5.5. <code>@~</code> project task/job modifier changes

The modifiers used in <code>@~</code> <em>project task</em> entries are significantly changed from the <em>etm</em> <code>@j</code> <em>job</em> entries. In <em>tklr</em>, the <code>&r</code> modifier is required and replaces both the <code>&i</code> <em>id</em> and the <code>&p</code> <em>prerequisite</em> modifiers. See [projects](#doghouse-example) for an example of the new usage.

### 5.6. Migrating reminders from <em>etm</em> to <em>tklr</em>

<div style="overflow:auto;">
  <pre style="float:right; margin-left:20px; width:460px; background:#111; color:#ddd; padding:12px; border-radius:6px;">
<code>
% tklr migrate --help
Usage: tklr migrate [OPTIONS] ETM_DIR

  Convert ETM reminders into a Tklr batch-entry file
  for the current home.

  Migrated reminders will be extracted from the
  ``etm.json`` file in ETM_DIR .

  Example:

    tklr --home ~/.config/tklr migrate ~/etm

Options:
  --outfile FILE       Defaults to [--home]/etm.txt
  --secret TEXT        Secret from etm cfg.yaml used
                       to decode @m values. Absent a
                       valid 'secret', @m values will
                       be left encoded. (default:
                       None)
  --record-ids         Append @# tags with the
                       original etm record ids.
                       (default: False)
  --include-archive    Include archived etm entries.
                       (default: False)
  --types [*|-|%|~|!]  Restrict migration to specific
                       etm item types (default: all).
  --help               Show this message and exit.
</code>
<code>
% tklr add --help   
Usage: tklr add [OPTIONS] [ENTRY]...

Options:
  -f, --file PATH  Path to file with multiple entries.
  --batch          Use editor to create multiple
                   entries separated by blank lines.
  --help           Show this message and exit.
</code>
</pre>
    <p>The <em>tklr</em> <code>migrate</code> command can be used to export your <em>etm</em> reminders from <code>etm.json</code> to a text file from which they can be imported into </em>tklr</em>. 
    </p>
    <p>Once the text file is available, the <em>tklr</em> <code>add</code> command can be used to import the reminders from the text file into <em>tklr</em>.
    </p> 
    <p>Here's an example of the complete process for the case in which the <em>etm</em> home directory is <code>~/etm</code> and the <em>tklr</em> home directory is <code>~/tklr</code>:
    </p>
<pre>
% tklr --home ~/tklr migrate ~/etm
% tklr --home ~/tklr add -f ~/tklr/etm.txt
</pre>
    </div>
<div style="clear:both;"></div>


[↩︎](#table-of-contents)

## 6. Developer Guide

This section is for anyone interested in helping with the development of *tkrl*. It walks you through setting up a development environment for `tklr` using [`uv`](https://github.com/astral-sh/uv) and a local virtual environment with a clone of the github repository. 

#### ✅ Step 1: Clone/Update the repository

This step will create a directory named _tklr-dgraham_ in your current working directory that contains a clone of the github repository for _tklr_.

```bash
git clone https://github.com/dagraham/tklr-dgraham.git
cd tklr-dgraham
```

Later, to update your local copy of **Tklr** to the latest version:

```bash
# Navigate to your project directory
cd ~/Projects/tklr-dgraham  # adjust this path as needed

# Pull the latest changes from GitHub
git pull origin master

# Reinstall in editable mode (picks up new code and dependencies)
uv pip install -e .
```

#### ✅ Step 2: Install uv (if needed)

```bash
which uv || curl -LsSf https://astral.sh/uv/install.sh | sh
```

#### ✅ Step 3: Create a virtual environment with `uv`

This will create a `.venv/` directory inside your project to hold all the relevant imports.

```bash
uv venv
```

#### ✅ Step 4: Install the project in editable mode

```bash
uv pip install -e .
```

#### ✅ Step 5: Use the CLI

You have two options for activating the virtual environment for the CLI:

##### ☑️ Option 1: Manual activation (every session)

```bash
source .venv/bin/activate
```

Then you can run:

```bash
tklr --version
tklr add "- test task @s 2025-08-01"
tklr ui
```

To deactivate:

```bash
deactivate
```

##### ☑️ Option 2: Automatic activation with `direnv` (recommended)

###### Install `direnv`

```bash
brew install direnv        # macOS
sudo apt install direnv    # Ubuntu/Debian
```

###### Add the shell hook to your `~/.zshrc` or `~/.bashrc`

```sh
eval "$(direnv hook zsh)"   # or bash
```

Restart your shell or run `source ~/.zshrc`.

###### In the project directory, create a `.envrc` file

```bash
echo 'export PATH="$PWD/.venv/bin:$PATH"' > .envrc
```

###### Allow it

```bash
direnv allow
```

Now every time you `cd` into the project, your environment is activated automatically and, as with the manual option, test your setup with

```bash
tklr --version
tklr add "- test task @s 2025-08-01"
tklr ui
```

You're now ready to develop, test, and run `tklr` locally with full CLI and UI support.
