outlook-cli 1.2.0

package/CLI.md

@@ -0,0 +1,89 @@
+# CLI Quick Reference
+
+Use this file as a fast command cheat sheet.
+For complete parameter-by-parameter documentation, use [docs/REFERENCE.md](docs/REFERENCE.md).
+
+## Install
+
+```bash
+npm i -g outlook-cli
+outlook-cli --help
+```
+
+## Global options
+
+- `--json`
+- `--output text|json`
+- `--plain`
+- `--no-color`
+- `--no-animate`
+- `--help`
+- `--version`
+
+## Discovery
+
+```bash
+outlook-cli commands
+outlook-cli tools list
+outlook-cli tools schema send-email
+```
+
+## Auth
+
+```bash
+outlook-cli auth status
+outlook-cli auth url
+outlook-cli auth login --open --start-server --wait --timeout 180
+outlook-cli auth logout
+```
+
+## Email
+
+```bash
+outlook-cli email list --folder inbox --count 20
+outlook-cli email search --query "invoice" --unread-only true --count 10
+outlook-cli email read --id <message-id>
+outlook-cli email send --to jane@example.com --subject "Status" --body "Done"
+outlook-cli email mark-read --id <message-id> --is-read true
+```
+
+## Calendar
+
+```bash
+outlook-cli calendar list --count 15
+outlook-cli calendar create --subject "Planning" --start "2026-04-03T10:00:00" --end "2026-04-03T11:00:00" --attendees a@x.com,b@y.com
+outlook-cli calendar decline --event-id <event-id> --comment "Conflict"
+outlook-cli calendar cancel --event-id <event-id>
+outlook-cli calendar delete --event-id <event-id>
+```
+
+## Folder
+
+```bash
+outlook-cli folder list --include-item-counts true --include-children true
+outlook-cli folder create --name "Important"
+outlook-cli folder move --email-ids <id1>,<id2> --target-folder "Important"
+```
+
+## Rule
+
+```bash
+outlook-cli rule list --include-details true
+outlook-cli rule create --name "Move invoices" --contains-subject "invoice" --move-to-folder "Finance"
+outlook-cli rule sequence --rule-name "Move invoices" --sequence 5
+```
+
+## Generic tool call
+
+```bash
+outlook-cli call search-emails --arg query=invoice --arg unreadOnly=true
+outlook-cli call create-event --args-json '{"subject":"Standup","start":"2026-04-03T09:00:00","end":"2026-04-03T09:30:00"}'
+```
+
+## Diagnostics and update
+
+```bash
+outlook-cli doctor
+outlook-cli update
+outlook-cli update --run
+```

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 outlook-cli contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/QUICKSTART.md

@@ -0,0 +1,104 @@
+# Quick Start - outlook-cli
+
+## 1. Install globally
+
+```bash
+npm i -g outlook-cli
+```
+
+Verify install:
+
+```bash
+outlook-cli --version
+outlook-cli doctor
+```
+
+## 2. Provide Microsoft credentials
+
+Set one of these credential pairs:
+
+- `OUTLOOK_CLIENT_ID` and `OUTLOOK_CLIENT_SECRET` (preferred)
+- `MS_CLIENT_ID` and `MS_CLIENT_SECRET` (backward-compatible)
+
+On PowerShell (current session):
+
+```powershell
+$env:OUTLOOK_CLIENT_ID="<your-client-id>"
+$env:OUTLOOK_CLIENT_SECRET="<your-client-secret>"
+```
+
+## 3. Authenticate once
+
+Start the auth callback server in one terminal:
+
+```bash
+outlook-cli auth login --start-server --wait
+```
+
+Optional browser auto-open:
+
+```bash
+outlook-cli auth login --open --start-server --wait
+```
+
+Token behavior:
+
+- Token is stored in your user profile.
+- It is reused across runs, reinstalls, and updates.
+- Refresh is handled automatically when possible.
+
+## 4. Run commands
+
+```bash
+outlook-cli commands
+outlook-cli tools list
+outlook-cli email list --count 10
+outlook-cli calendar list --count 10
+```
+
+Machine-readable output:
+
+```bash
+outlook-cli auth status --json
+outlook-cli call list-emails --args-json '{"count":5}' --json
+```
+
+## 5. Update
+
+```bash
+npm i -g outlook-cli@latest
+# or
+outlook-cli update --run
+```
+
+## Optional: MCP server mode
+
+If you want to connect this project as a standard MCP server for clients such as Claude Desktop:
+
+```bash
+npm run mcp-server
+```
+
+Then point your MCP client config to `index.js` and set the same credential environment variables.
+
+## Troubleshooting
+
+- Run `outlook-cli doctor` first.
+- Re-authenticate if needed:
+
+```bash
+outlook-cli auth logout
+outlook-cli auth login --open --start-server --wait
+```
+
+- If port 3333 is already in use:
+
+```bash
+npx kill-port 3333
+```
+
+## Next docs
+
+- Full command and parameter reference: [docs/REFERENCE.md](docs/REFERENCE.md)
+- CLI cheat sheet: [CLI.md](CLI.md)
+- Publish checklist: [docs/PUBLISHING.md](docs/PUBLISHING.md)