inngest-cli 0.14.5 → 0.15.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.
- package/README.md +46 -17
- package/package.json +1 -1
- package/postinstall.js +1 -1
package/README.md
CHANGED
|
@@ -1,13 +1,41 @@
|
|
|
1
|
-
# Inngest
|
|
1
|
+
# [](https://www.inngest.com)
|
|
2
2
|
|
|
3
3
|
[](https://github.com/inngest/inngest/releases)
|
|
4
4
|
[](https://github.com/inngest/inngest/actions?query=branch%3Amain)
|
|
5
5
|
[](https://www.inngest.com/discord)
|
|
6
6
|
[](https://twitter.com/inngest)
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
[Inngest](https://www.inngest.com) is the developer platform for easily building reliable workflows with zero infrastructure.
|
|
9
9
|
|
|
10
|
-
<
|
|
10
|
+
<div align="center">
|
|
11
|
+
|
|
12
|
+
<a href="https://www.inngest.com/uses/serverless-node-background-jobs?ref=org-readme">
|
|
13
|
+
Background Jobs
|
|
14
|
+
</a> |
|
|
15
|
+
|
|
16
|
+
<a href="https://www.inngest.com/uses/serverless-queues?ref=org-readme">
|
|
17
|
+
Serverless Queues
|
|
18
|
+
</a> |
|
|
19
|
+
|
|
20
|
+
<a href="https://www.inngest.com/docs/functions/multi-step?ref=org-readme">
|
|
21
|
+
Workflows
|
|
22
|
+
</a> |
|
|
23
|
+
|
|
24
|
+
<a href="https://www.inngest.com/uses/zero-infra-llm-ai?ref=org-readme">
|
|
25
|
+
AI & LLM Chains
|
|
26
|
+
</a> |
|
|
27
|
+
|
|
28
|
+
<a href="https://www.inngest.com/uses/serverless-cron-jobs?ref=org-readme">
|
|
29
|
+
Scheduled Jobs
|
|
30
|
+
</a>
|
|
31
|
+
</div>
|
|
32
|
+
<br/>
|
|
33
|
+
|
|
34
|
+
- Write background jobs and workflows in your existing codebase using the [**Inngest SDK**](https://github.com/inngest/inngest-js)
|
|
35
|
+
- Run the open source [**Inngest Dev Server**](#the-inngest-dev-server) on your machine for a complete local development experience, with production parity.
|
|
36
|
+
- The **Inngest Platform** invokes your code wherever you host it, via HTTPS. Deploy to your existing setup, and deliver products faster without managing infrastructure.
|
|
37
|
+
|
|
38
|
+
---
|
|
11
39
|
|
|
12
40
|
- [Overview](#overview)
|
|
13
41
|
- [Quick Start](#quick-start)
|
|
@@ -16,29 +44,30 @@ Run reliable serverless functions in the background. Inngest allows you to sched
|
|
|
16
44
|
|
|
17
45
|
<br />
|
|
18
46
|
|
|
19
|
-
The
|
|
47
|
+
#### The Inngest Dev Server
|
|
48
|
+
|
|
49
|
+
```
|
|
50
|
+
npx inngest-cli@latest dev
|
|
51
|
+
```
|
|
20
52
|
|
|
21
|
-
|
|
22
54
|
|
|
23
55
|
<br />
|
|
24
56
|
|
|
25
57
|
## Overview
|
|
26
58
|
|
|
27
|
-
Inngest makes it
|
|
59
|
+
Inngest makes it easy to develop serverless workflows in your existing codebase, without any new infrastructure. Inngest Functions are triggered via events — decoupling your code within your application.
|
|
28
60
|
|
|
29
|
-
|
|
30
|
-
|
|
61
|
+
1. You define your Inngest functions using the [Inngest SDK](https://github.com/inngest/inngest-js) and serve them through a [simple API endpoint](https://www.inngest.com/docs/sdk/serve?ref=github-inngest-readme).
|
|
62
|
+
2. Inngest automatically invokes your functions via HTTPS whenever you send events from your application.
|
|
31
63
|
|
|
32
64
|
Inngest abstracts the complex parts of building a robust, reliable, and scalable architecture away from you, so you can focus on writing amazing code and building applications for your users.
|
|
33
65
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
-
|
|
37
|
-
- Event-driven systems are better than regular, procedural systems and queues
|
|
38
|
-
- Developer experience matters
|
|
39
|
-
- Serverless scheduling enables scalable, reliable systems that are both cheaper and better for compliance
|
|
66
|
+
- **Run your code anywhere** - We call you via HTTPS so you can deploy your code to serverless, servers or the edge.
|
|
67
|
+
- **Zero-infrastructure required** - No queues or workers to configure or manage — just write code and Inngest does the rest.
|
|
68
|
+
- **Build complex workflows with simple primitives** - [Our SDK](https://github.com/inngest/inngest-js) provides easy to learn `step` tools like [`run`](https://www.inngest.com/docs/reference/functions/step-run?ref=github-inngest-readme), [`sleep`](https://www.inngest.com/docs/reference/functions/step-sleep?ref=github-inngest-readme), [`sleepUntil`](https://www.inngest.com/docs/reference/functions/step-sleep-until?ref=github-inngest-readme), and [`waitForEvent`](https://www.inngest.com/docs/reference/functions/step-wait-for-event?ref=github-inngest-readme) that you can combine using code and patterns that you're used to create complex and robust workflows.
|
|
40
69
|
|
|
41
|
-
[Read more about our vision and why this
|
|
70
|
+
[Read more about our vision and why this Inngest exists](https://www.inngest.com/blog/inngest-add-super-powers-to-serverless-functions)
|
|
42
71
|
|
|
43
72
|
<br />
|
|
44
73
|
|
|
@@ -47,7 +76,7 @@ We created Inngest to bring the benefits of event-driven systems to all develope
|
|
|
47
76
|
👉 [Read the full quick start guide here](https://www.inngest.com/docs/quick-start?ref=github-inngest-readme)
|
|
48
77
|
|
|
49
78
|
1. [NPM install our SDK for your typescript project](https://github.com/inngest/inngest-js): `npm install inngest`
|
|
50
|
-
2. Run the Inngest dev server: `npx inngest@latest dev` (This repo's CLI)
|
|
79
|
+
2. Run the Inngest dev server: `npx inngest-cli@latest dev` (This repo's CLI)
|
|
51
80
|
3. [Integrate Inngest with your framework in one line](https://www.inngest.com/docs/sdk/serve?ref=github-inngest-readme) via the `serve()` handler
|
|
52
81
|
4. [Write and run functions in your existing framework or project](https://www.inngest.com/docs/functions?ref=github-inngest-readme)
|
|
53
82
|
|
|
@@ -110,7 +139,7 @@ Inngest’s architecture is made up of 6 core components:
|
|
|
110
139
|
|
|
111
140
|
And, in this CLI:
|
|
112
141
|
|
|
113
|
-
- The **DevServer** combines all the components and basic drivers for each into a single system which
|
|
142
|
+
- The **DevServer** combines all the components and basic drivers for each into a single system which reads all functions from your application running on your machine, handles incoming events via the API and executes functions, all returning a readable output to the developer.
|
|
114
143
|
|
|
115
144
|
For specific information on how the DevServer works and how it compares to production [read this doc](/docs/DEVSERVER_ARCHITECTURE.md).
|
|
116
145
|
|
package/package.json
CHANGED