opscrew 0.1.1 → 0.1.3
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.
- package/README.md +7 -0
- package/dist/opscrew.js +47070 -32213
- package/package.json +3 -1
package/README.md
CHANGED
|
@@ -51,6 +51,11 @@ What runs next to your app:
|
|
|
51
51
|
- [Message brokers and queues](https://docs.opscrew.dev/brokers/): Valkey (or Redis 8 or Dragonfly), RabbitMQ, NATS, Kafka and Redpanda.
|
|
52
52
|
- [Search and analytics engines](https://docs.opscrew.dev/search-and-analytics/): OpenSearch, Elasticsearch, Meilisearch, Typesense, ClickHouse and Neo4j.
|
|
53
53
|
|
|
54
|
+
How you watch it, for free:
|
|
55
|
+
- [Logs and resource figures](https://docs.opscrew.dev/logs-and-status/): `opscrew logs` and `opscrew status` on every target, secrets masked.
|
|
56
|
+
- [Alerts](https://docs.opscrew.dev/alerts/): a scheduled check in GitHub Actions opens an issue when the app is down, its certificate expires or its disk fills up, with an optional Slack, Discord or ntfy message.
|
|
57
|
+
- [Beszel](https://docs.opscrew.dev/beszel/) and [Grafana Cloud](https://docs.opscrew.dev/grafana-cloud/): opt-in charts, history and log search.
|
|
58
|
+
|
|
54
59
|
## Quickstart
|
|
55
60
|
|
|
56
61
|
You need Node.js 22.9+, git, OpenTofu or Terraform, a GitHub repository with your app, and an API token for Hetzner Cloud (`HCLOUD_TOKEN`) or DigitalOcean (`DIGITALOCEAN_TOKEN`). For a custom domain, add a Cloudflare token (`CLOUDFLARE_API_TOKEN`) and a domain whose DNS is on Cloudflare. A GitHub token (`GITHUB_TOKEN`, or a logged-in `gh`) lets OpsCrew open pull requests and set the deploy secrets. A model (`ANTHROPIC_API_KEY`) is optional: pass `--no-ai` to `analyze` and `adapt` to run without one.
|
|
@@ -71,6 +76,8 @@ In Claude Code, the OpsCrew plugin runs the same steps from the chat, and every
|
|
|
71
76
|
|
|
72
77
|
## After the first deploy
|
|
73
78
|
|
|
79
|
+
- `npx opscrew logs` shows the app's log lines (`--follow` for new ones), and `npx opscrew status` what runs with its CPU, memory and disk. See [Your app's logs and resource figures](https://docs.opscrew.dev/logs-and-status/).
|
|
80
|
+
- A deploy or a provision failed? See [When a deploy fails, and how to recover](https://docs.opscrew.dev/when-a-deploy-fails/): what your visitors get, what OpsCrew already put back and what to do next.
|
|
74
81
|
- `npx opscrew destroy` deletes the deployment's infrastructure. It asks you to type the server name first and can take a snapshot.
|
|
75
82
|
- `npx opscrew retarget --to <provider>` moves a live app to another cloud provider with its data (not yet to or from your own server or a Portainer). It builds the new server next to the old one, copies the database in a short maintenance window and switches DNS. The old server is deleted only when you run `opscrew retarget --finish`.
|
|
76
83
|
- No domain yet? `npx opscrew domain buy <domain>` buys one at cost after you confirm the price, through Cloudflare, Porkbun, Namecheap or GoDaddy. Already own one? `npx opscrew domain connect <domain>` moves its DNS to Cloudflare. See [Buying or connecting a domain](https://docs.opscrew.dev/domains/).
|