opscrew 0.1.0 → 0.1.2

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 (5) hide show
  1. package/LICENSE +1 -1
  2. package/NOTICE +1 -1
  3. package/README.md +11 -3
  4. package/dist/opscrew.js +32904 -23937
  5. package/package.json +11 -3
package/LICENSE CHANGED
@@ -187,7 +187,7 @@
187
187
  same "printed page" as the copyright notice for easier
188
188
  identification within third-party archives.
189
189
 
190
- Copyright [yyyy] [name of copyright owner]
190
+ Copyright 2026 Mihailo Popović
191
191
 
192
192
  Licensed under the Apache License, Version 2.0 (the "License");
193
193
  you may not use this file except in compliance with the License.
package/NOTICE CHANGED
@@ -1,5 +1,5 @@
1
1
  OpsCrew
2
- Copyright 2026 The OpsCrew Authors
2
+ Copyright 2026 Mihailo Popović
3
3
 
4
4
  This product is licensed under the Apache License, Version 2.0 (see LICENSE),
5
5
  except for the contents of the ee/ directory, which are licensed under the
package/README.md CHANGED
@@ -1,6 +1,4 @@
1
- # OpsCrew
2
-
3
- **The ops crew you didn't hire.**
1
+ <p align="center"><img src="https://raw.githubusercontent.com/softzer0/opscrew/main/.github/assets/opscrew-header.png" alt="OpsCrew: the ops crew you didn't hire" width="100%"></p>
4
2
 
5
3
  From a GitHub repo to a hardened production deployment on your own cloud. Any cloud. You keep the infrastructure code.
6
4
 
@@ -26,6 +24,8 @@ Where it deploys:
26
24
  - **A server you already have, shared by several OpsCrew apps if you like:** see [Deploy to a server you already have](https://docs.opscrew.dev/own-server/).
27
25
  - **A Portainer you already run, for example on a NAS:** see [Deploy to a Portainer you already run](https://docs.opscrew.dev/portainer-target/). OpsCrew can also add [Portainer](https://docs.opscrew.dev/portainer/) to a server as a web UI for your containers.
28
26
  - **Your own computer, with the same production stack in your Docker:** see [Your app's production stack on your own computer](https://docs.opscrew.dev/localhost/). No server, no cloud account and no domain needed.
27
+ - **Cloudflare, with no server, for static and server-rendered sites:** see [Host your site on Cloudflare](https://docs.opscrew.dev/cloudflare-hosting/). Free for static files.
28
+ - **GitHub Pages, for static sites in public repositories:** see [Publish your site on GitHub Pages](https://docs.opscrew.dev/github-pages/). Free, without custom headers or commercial use.
29
29
 
30
30
  One app can have several environments, such as dev on your computer, staging on a small server and prod on the live one, and a tested image moves to prod unchanged: see [dev, staging and prod](https://docs.opscrew.dev/environments/). Deploy jobs can also run on the server itself or on your computer: see [Self-hosted runners](https://docs.opscrew.dev/runners/).
31
31
 
@@ -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.
@@ -67,8 +72,11 @@ Run these in your app's repository, in order:
67
72
 
68
73
  To install it once instead of fetching it with `npx` each time, run `npm install -g opscrew`, then `opscrew init`, `opscrew analyze` and so on.
69
74
 
75
+ In Claude Code, the OpsCrew plugin runs the same steps from the chat, and every plan still waits for your approval: `/plugin marketplace add softzer0/opscrew`, then `/plugin install opscrew@opscrew`. See [the plugin's README](https://github.com/softzer0/opscrew/tree/main/plugin).
76
+
70
77
  ## After the first deploy
71
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/).
72
80
  - `npx opscrew destroy` deletes the deployment's infrastructure. It asks you to type the server name first and can take a snapshot.
73
81
  - `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`.
74
82
  - 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/).