@inboxzero/cli 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +115 -0
  2. package/bin/inbox-zero.js +7388 -0
  3. package/package.json +48 -0
package/README.md ADDED
@@ -0,0 +1,115 @@
1
+ # @inbox-zero/cli
2
+
3
+ CLI tool for running [Inbox Zero](https://www.getinboxzero.com) - an open-source AI email assistant.
4
+
5
+ ## Installation
6
+
7
+ ### Homebrew (macOS/Linux)
8
+
9
+ ```bash
10
+ brew install inbox-zero/inbox-zero/inbox-zero
11
+ ```
12
+
13
+ ### Manual Installation
14
+
15
+ Download the binary for your platform from [releases](https://github.com/elie222/inbox-zero/releases) and add to your PATH.
16
+
17
+ ## Quick Start
18
+
19
+ ```bash
20
+ # Configure Inbox Zero (interactive)
21
+ inbox-zero setup
22
+
23
+ # Start Inbox Zero
24
+ inbox-zero start
25
+
26
+ # Open http://localhost:3000
27
+ ```
28
+
29
+ ## Commands
30
+
31
+ ### `inbox-zero setup`
32
+
33
+ Interactive setup wizard that:
34
+ - Configures OAuth providers (Google/Microsoft)
35
+ - Sets up your LLM provider and API key
36
+ - Configures ports (to avoid conflicts)
37
+ - Generates all required secrets
38
+
39
+ Configuration is stored in `~/.inbox-zero/`
40
+
41
+ ### `inbox-zero setup-terraform`
42
+
43
+ Generates Terraform files for AWS deployment (ECS Fargate, RDS, optional Redis).
44
+
45
+ ```bash
46
+ # Generate Terraform files in ./terraform (interactive)
47
+ inbox-zero setup-terraform
48
+
49
+ # Non-interactive mode (values read from flags/env vars)
50
+ inbox-zero setup-terraform --yes --region us-east-1
51
+ ```
52
+
53
+ The generated Terraform uses AWS SSM Parameter Store for secrets and outputs the
54
+ service URL after `terraform apply`.
55
+
56
+ ### `inbox-zero start`
57
+
58
+ Pulls the latest Docker image and starts all containers:
59
+ - PostgreSQL database
60
+ - Redis cache
61
+ - Inbox Zero web app
62
+ - Cron job for email sync
63
+
64
+ ```bash
65
+ inbox-zero start # Start in background
66
+ inbox-zero start --no-detach # Start in foreground
67
+ ```
68
+
69
+ ### `inbox-zero stop`
70
+
71
+ Stops all running containers.
72
+
73
+ ```bash
74
+ inbox-zero stop
75
+ ```
76
+
77
+ ### `inbox-zero logs`
78
+
79
+ View container logs.
80
+
81
+ ```bash
82
+ inbox-zero logs # Show last 100 lines
83
+ inbox-zero logs -f # Follow logs
84
+ inbox-zero logs -n 500 # Show last 500 lines
85
+ ```
86
+
87
+ ### `inbox-zero status`
88
+
89
+ Show status of running containers.
90
+
91
+ ### `inbox-zero update`
92
+
93
+ Pull the latest Inbox Zero image and optionally restart.
94
+
95
+ ```bash
96
+ inbox-zero update
97
+ ```
98
+
99
+ ## Requirements
100
+
101
+ - [Docker Desktop](https://www.docker.com/products/docker-desktop/) installed and running
102
+ - OAuth credentials from Google and/or Microsoft
103
+ - An LLM API key (Anthropic, OpenAI, Google, etc.)
104
+
105
+ ## Configuration
106
+
107
+ All configuration is stored in `~/.inbox-zero/`:
108
+ - `.env` - Environment variables
109
+ - `docker-compose.yml` - Docker Compose configuration
110
+
111
+ To reconfigure, run `inbox-zero setup` again.
112
+
113
+ ## License
114
+
115
+ See [LICENSE](../../LICENSE) in the repository root.