Metadata-Version: 2.5
Name: awask
Version: 0.1.0
Summary: Your agent asks you a question — and acts on your answer. Durable decision cards for agents: a structured ask, delivered wherever you are, whose answer steers the run that raised it.
Project-URL: Homepage, https://aitherium.com
Project-URL: Source, https://github.com/Aitherium/awask
Author-email: Aitherium <hello@aitherium.com>
License: 
                                         Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
License-File: LICENSE
Keywords: agents,approval,claude-code,cli,decisions,human-in-the-loop
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.9
Provides-Extra: chat
Requires-Dist: httpx>=0.25.0; extra == 'chat'
Description-Content-Type: text/markdown

# awask — your agent asks you a question, and acts on your answer

An agent that needs a human has one channel today: prose in a terminal. That channel
loses. The deciding sentence sits in paragraph four, you are in another window, and
the run sits idle for forty minutes because nothing told you it was waiting.

`awask` makes the ask a **thing** instead of a line of text: a small structured card
in a durable store, rendered by every surface, whose answer is carried back into the
run that raised it.

```bash
pip install awask
```

Python 3.9+. **Zero dependencies** — standard library only. The store is a directory
of JSON files, so this is the entire setup: no server, no login, no network, nothing
to start before it works.

## Ask something

```bash
awask ask "Ship the migration now, or hold for review?" \
  --summary "Tests pass. The rollback path is untested." \
  --fact "312 rows affected" \
  --fact "rollback has never been run against prod data" \
  --option "ship|Ship it|live in ~2 min, rollback unproven" \
  --option "hold|Hold for review|no risk, blocks tonight's release" \
  --recommend hold --default hold --urgency high
```

Returns immediately. Your agent keeps working; you answer at your own pace.

```bash
awask list                      # what is waiting on you
awask show <id>                 # one card in full
awask answer <id> hold          # pick an option
awask steer <id> "check the FK constraint first"   # guidance; card stays open
awask cancel <id>               # withdraw it — you solved it yourself
```

Use `|` as the option separator, never `:` — a Windows path in a consequence
(`C:\data`) silently mangles with the colon form.

## Close the loop in Claude Code

The CLI alone gives you cards when an agent types the command, and delivers your
answer at your next prompt. To make it automatic:

```bash
awask install-hooks          # this project
awask install-hooks --user   # every project
awask install-hooks --dry-run
```

That writes three hooks and merges three entries into `settings.json`:

| event | hook | what it does |
|---|---|---|
| `Stop` | `stop_awask_cards.py` | holds the turn open ~50s so your answer resumes the run |
| `UserPromptSubmit` | `awask_mailbox_drain.py` | **carries your answer INTO the session** |
| `Notification` | `awask_notification_card.py` | "the agent is waiting" becomes a card |

**The middle one is the one people skip and the one that matters.** Without it you can
answer a card and the agent never learns you did — the card renders, you click, the
store records a resolution, and the run carries on as though nobody replied. Every
component reports success.

Your existing `settings.json` is **merged, never replaced**; re-running is a no-op;
a malformed settings file is refused rather than overwritten; and every hook is run
with `--self-test` after being written, because a copy is not an install.

## The five fields that make a card decidable

A card that cannot be answered from a phone lock screen is not finished.

1. **Title** — one line, the whole ask. If it needs two, raise two cards.
2. **Facts** — what you *measured*, not what you guess. Highest-value field here.
3. **Options** — each with a **consequence**. A label says what a choice is called; a
   consequence says what happens to your machine. Only the consequence lets someone
   decide without reading the code.
4. **`--recommend`** — say what you would do. A card with no recommendation pushes
   your thinking onto the human.
5. **`--default`** — what happens if nobody ever answers. **Required**: a card is only
   safe to ignore if it says what ignoring it does. An agent that cannot name a
   default is not blocked on a decision, it is blocked on doing its own thinking.

## When to raise one — the bar is high

**A card is an interruption. The default is to keep working.** Raise one only when
all three hold:

1. The answers lead to **materially different work**, and
2. **A wrong guess costs real work** to undo — time, money, data, or something
   outward-facing, and
3. **You cannot settle it yourself** by reading, measuring, or taking the
   conventional default.

If any clause fails: decide it, say so in one line, keep going. "Should I continue?"
is the anti-pattern.

## From Python

```python
from awask import DecisionCard, DecisionOption, get_store

card = get_store().create(DecisionCard(
    title="Two schema designs, both defensible",
    options=[
        DecisionOption(key="a", label="Single table", consequence="faster reads, wide rows"),
        DecisionOption(key="b", label="Join table", consequence="normalized, extra hop"),
    ],
    recommend="b", default="b",
))
print(card.id)
```

## Answering from elsewhere

`awask list/show/answer/cancel` read the store on local disk directly, so a fresh
install works with nothing running. Reaching those cards from another device — a
phone, a browser, a dashboard — needs a small local HTTP daemon serving the same
store, bound to loopback and fronted by a private tunnel or an authenticated proxy.
Never publish that port: it serves the queue that steers an agent with filesystem
access.

**Nothing starts that daemon for you, deliberately** — registering a background
service is a bigger ask than installing a CLI. The cost is worth naming: if it is
not running, remote surfaces have no cards to show, and an empty list looks exactly
like "nothing is waiting on you". A client that cannot reach it should say so.

## Delivery to a chat DM

`awask.channels` bridges cards to a Discord/Telegram/Slack **direct message** — your
bot, your token, bound to your user id. It is a DM bridge, not a channel bot, and
that is the entire security model: **a card answer steers an agent with filesystem
access**, so "who may answer" is an authorization decision. It fails closed at every
path — no config, no bound owner, a sender who is not the owner, or a message that
is not in a DM, all deny. A message in a public channel cannot answer a card even
when you typed it.

## Licence

Apache 2.0.
