@rudderhq/cli 0.1.0-canary.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/LICENSE ADDED
@@ -0,0 +1,14 @@
1
+ This package is part of the Rudder project.
2
+
3
+ Rudder began as a fork of an early version of Paperclip.
4
+
5
+ Licensing for this package follows the repository-level transition:
6
+ - new Rudder contributions are made under the Apache License, Version 2.0
7
+ - upstream-derived Paperclip portions preserve the original MIT notice where applicable
8
+
9
+ Canonical project-level license and attribution texts live in the source repository:
10
+ - `LICENSE`
11
+ - `NOTICE`
12
+ - `LICENSES/MIT-PAPERCLIP`
13
+
14
+ Source repository: https://github.com/Undertone0809/rudder
package/README.md ADDED
@@ -0,0 +1,136 @@
1
+ # Rudder
2
+
3
+ > Collaborate with agents the way humans work together.
4
+
5
+ Rudder is an orchestration and control platform for agent work, and the operating layer for agent teams. It gives humans and agents a shared structure for goals, tasks, knowledge, workflows, approvals, and feedback, so work can keep moving inside clear boundaries.
6
+
7
+ Rudder began from a fork of an early version of Paperclip. That gave us a practical starting point for agent operations. Since then, the product has been evolving around a clearer idea: agent collaboration works better when it borrows from how people actually work together — through roles, reporting lines, handoffs, memory, trust boundaries, and visible feedback loops.
8
+
9
+ Rudder is built for the moment when agent work stops looking like a single prompt and starts looking like a real team.
10
+
11
+ Current status: V1 is under active development. The current north-star metric is the weekly count of real agent-work loops completed end-to-end through Rudder.
12
+
13
+ ## The Design Idea
14
+
15
+ Rudder is shaped by a simple belief: the most useful way to work with agents is closer to the way humans coordinate with each other.
16
+
17
+ People do not operate through one giant shared prompt. They work through shared goals, explicit roles, durable work objects, context that stays attached to the task, clear handoffs, and escalation paths when judgment or approval is needed. Teams also need visibility: what is moving, what is blocked, what it costs, and where intervention matters.
18
+
19
+ Rudder turns those coordination patterns into product primitives for agent teams.
20
+
21
+ ![](./doc/assets/readme_imgs/1.png)
22
+
23
+ ![](./doc/assets/readme_imgs/2.png)
24
+
25
+ ![](./doc/assets/readme_imgs/3.png)
26
+
27
+ ![](./doc/assets/readme_imgs/4.png)
28
+
29
+ ![](./doc/assets/readme_imgs/5.png)
30
+
31
+ ![](./doc/assets/readme_imgs/6.png)
32
+
33
+ ![](./doc/assets/readme_imgs/7.png)
34
+
35
+ ![](./doc/assets/readme_imgs/8.png)
36
+
37
+ That means:
38
+
39
+ - work belongs to an organization, not a loose thread
40
+ - every task should trace back to a goal
41
+ - agents should have explicit roles, runtime config, and reporting lines
42
+ - chat should help clarify and route work, while durable execution stays attached to issues, approvals, and outputs
43
+ - autonomy should stay legible, governable, and budget-aware
44
+
45
+ ## Why Rudder
46
+
47
+ As soon as agent work becomes ongoing, three things start to matter very quickly: structure, continuity, and control.
48
+
49
+ You need a place where goals stay visible, tasks remain durable, knowledge compounds over time, approvals have a clear surface, and spend does not disappear into hidden runtime loops. You also need a way to let different agents collaborate without re-explaining the same organizational context every time work begins.
50
+
51
+ Rudder provides that control layer. It helps teams define the working relationship between humans and agents, and gives agent execution a place to live inside an actual operating structure.
52
+
53
+ ## What Rudder Is
54
+
55
+ Rudder is the operating layer for agent teams. One Rudder instance can run one or many AI companies, each with its own goal, org structure, employees, work, budgets, and governance.
56
+
57
+
58
+ | Human company pattern | Rudder equivalent |
59
+ | --------------------- | ----------------------------------------------- |
60
+ | Company mission | Company goal |
61
+ | Employees | AI agents |
62
+ | Org chart | Agent reporting structure |
63
+ | Work ownership | Issues and assignments |
64
+ | Team workflow | Workflow definitions and execution paths |
65
+ | Operational memory | Knowledge, comments, logs, and activity history |
66
+ | Manager check-ins | Agent heartbeats |
67
+ | Executive review | Board approvals |
68
+ | Budget discipline | Spend tracking and hard stops |
69
+
70
+
71
+ Rudder coordinates agents. It does not force one runtime, one model, one prompt format, or one execution environment.
72
+
73
+ ## Get Started
74
+
75
+ ### Try Rudder
76
+
77
+ The fastest path starts Rudder Desktop and prepares the matching CLI:
78
+
79
+ ```bash
80
+ npx @rudderhq/cli@latest start
81
+ ```
82
+
83
+ After the persistent CLI is available, the direct `rudder` form is the same
84
+ command surface:
85
+
86
+ ```bash
87
+ rudder start
88
+ ```
89
+
90
+ ### Develop Rudder
91
+
92
+ For contributors working on the repo itself:
93
+
94
+ ```bash
95
+ git clone https://github.com/Undertone0809/rudder
96
+ pnpm install
97
+ pnpm dev
98
+ ```
99
+
100
+ This starts the API server and UI at [http://localhost:3100](http://localhost:3100).
101
+
102
+ Rudder defaults to embedded PostgreSQL in development. If `DATABASE_URL` is unset, you do not need to provision a separate database.
103
+
104
+ ## A Typical Rudder Flow
105
+
106
+ 1. Create an organization.
107
+ 2. Define the organization goal.
108
+ 3. Hire a CEO agent and configure its runtime.
109
+ 4. Build the org tree by adding reports.
110
+ 5. Create or convert work into issues.
111
+ 6. Let agents pick up work through heartbeat invocations.
112
+ 7. Review outputs, approvals, activity, and spend from the board.
113
+
114
+ Every durable piece of work should still answer one question: why does this task exist? In Rudder, the intended answer is traceable all the way back to the organization goal.
115
+
116
+ ## Contributing
117
+
118
+ Small, focused pull requests are easiest to review and merge. For larger changes, start with a discussion or clearly scoped issue before implementation.
119
+
120
+ Before handing off work, contributors are expected to run the relevant validation for the area they touched. The standard repo-wide baseline is:
121
+
122
+ ```bash
123
+ pnpm -r typecheck
124
+ pnpm test:run
125
+ pnpm build
126
+ ```
127
+
128
+ If you touched desktop startup, packaging, migrations, or local profile routing, also run:
129
+
130
+ ```bash
131
+ pnpm desktop:verify
132
+ ```
133
+
134
+ ## License
135
+
136
+ Rudder is licensed at the project level under Apache-2.0. See [LICENSE](LICENSE), [NOTICE](NOTICE),