mirror of
https://github.com/proxysoul/Empryo.git
synced 2026-11-07 06:25:57 -10:00
docs: add demo and update docs
- add demo - license & readme
This commit is contained in:
9 files changed
+192
-3
No files matched your search
@@ -0,0 +1,135 @@
|
||||
Empryo License 1.0
|
||||
SPDX-License-Identifier: LicenseRef-Empryo-1.0
|
||||
|
||||
Copyright (c) 2025-2026 proxySoul. All rights reserved.
|
||||
Licensor: the copyright holder distributing Empryo under the name proxySoul.
|
||||
Commercial licensing contact: empryo@proxysoul.com
|
||||
|
||||
1. Scope
|
||||
|
||||
This license applies only to copies of Empryo v3 and later, including its
|
||||
first-party binaries, components, and any source code supplied with them,
|
||||
that the Licensor distributes with this license (the Software). References
|
||||
to the Software include modified and derivative versions and substantial
|
||||
portions of it. This license does not promise access to source code.
|
||||
|
||||
2. Free permitted use
|
||||
|
||||
Subject to this license, you may install, run, copy, and modify the Software
|
||||
for personal use, education, research, other non-commercial purposes, and
|
||||
your organization's internal business operations, including production use. Employees and contractors
|
||||
may use it on that organization's behalf. You may run it on your own
|
||||
machines or infrastructure operated on your behalf, including hosted CI
|
||||
runners and an internal service for your employees and contractors.
|
||||
|
||||
You may use the Software as a development or work tool to create, test,
|
||||
maintain, and deliver your own software, documents, and other work products,
|
||||
including products you sell and paid work you perform for clients. You may
|
||||
configure a client's installation or CI pipeline for the client's own
|
||||
internal use under this license. Paid consulting, training, and support are
|
||||
permitted when they do not provide the Software as a commercial offering
|
||||
as described in section 3.
|
||||
|
||||
You may share original or modified copies non-commercially if you include
|
||||
this license and all applicable copyright and third-party notices, clearly
|
||||
identify modifications, and do not charge for or monetize those copies or
|
||||
include them in a commercial offering. Recipients receive rights from the
|
||||
Licensor under this license, not a right to relicense the Software.
|
||||
|
||||
3. Commercialization requires a separate license
|
||||
|
||||
You must obtain the Licensor's explicit prior written permission in a
|
||||
separate commercial license before commercializing the Software.
|
||||
Commercialization includes:
|
||||
|
||||
(a) selling, renting, sublicensing for a fee, or otherwise commercially
|
||||
distributing the Software or modified versions;
|
||||
(b) providing the Software or its functionality to third parties as a
|
||||
commercial hosted, cloud, managed, white-label, or service-bureau offering;
|
||||
(c) embedding, bundling, wrapping, or integrating the Software or substantial
|
||||
portions of it into a product or service offered commercially to third
|
||||
parties; and
|
||||
(d) offering third-party access to the Software's functionality through a
|
||||
user interface, API, workflow, proxy, or other product or service as
|
||||
part of a commercial offering, even when the Software is installed
|
||||
separately by the user rather than included in the offering.
|
||||
|
||||
These restrictions apply whether payment is direct or indirect, including
|
||||
subscriptions, usage fees, advertising revenue, or a paid product or service
|
||||
with an ostensibly free Software-powered feature. A different name,
|
||||
additional features, or removal of features does not remove the requirement.
|
||||
|
||||
Using the Software internally to produce a deliverable is permitted under
|
||||
section 2. Giving customers access to the Software's agent or automation
|
||||
functionality as part of your offering is not internal use. For example,
|
||||
an employee using Empryo to build a company's paid app is permitted; selling
|
||||
Cloud Empryo, a hosted Empryo review bot, or a commercial Empryo wrapper
|
||||
requires a separate commercial license. No commercial license is granted
|
||||
merely by contacting the Licensor, sponsoring the project, or paying a model
|
||||
provider. Permission must be explicitly agreed in writing by the Licensor.
|
||||
|
||||
4. Your work and independent integrations
|
||||
|
||||
Using the Software does not grant the Licensor any ownership of, or license
|
||||
to, your inputs, projects, or work products. You do not owe the Licensor
|
||||
royalties, a revenue share, source disclosure, or attribution for work you
|
||||
create with the Software. Rights in existing Software or third-party
|
||||
material included in that work remain governed by their own licenses.
|
||||
|
||||
This license does not impose its terms on code, documents, or other output
|
||||
you create using the Software solely because you used it. You may use and
|
||||
sell those work products, including independently developed competing
|
||||
products, subject to any rights in material they contain. Software code or
|
||||
assets copied into an output remain subject to their applicable licenses.
|
||||
|
||||
Independently authored plugins, MCP servers, hooks, and other interoperable
|
||||
tools are not covered by this license merely because they work with Empryo.
|
||||
This does not authorize including Software code in them or using them to
|
||||
provide Empryo functionality as a commercial offering under section 3.
|
||||
|
||||
5. Existing rights and third-party components
|
||||
|
||||
This license does not revoke, replace, or restrict rights already granted
|
||||
under another license for earlier copies or separately licensed material.
|
||||
In particular, public SoulForge versions, their core and engine code, and
|
||||
copies previously distributed under the Business Source License 1.1 retain
|
||||
their applicable license terms, including any existing change-date rights.
|
||||
The license supplied with a particular copy determines its terms.
|
||||
|
||||
Third-party components retain their own licenses. Nothing here limits rights
|
||||
granted by those licenses or rights that applicable law does not allow the
|
||||
Licensor to restrict. This license grants only rights the Licensor is
|
||||
entitled to grant; it does not relicense another contributor's work without
|
||||
the necessary permission. Notices identifying separately licensed material
|
||||
must be retained.
|
||||
|
||||
There is no automatic change to an open-source license for the Software
|
||||
covered by this license. Earlier licenses' conversion provisions remain
|
||||
unchanged for the copies and material to which they apply.
|
||||
|
||||
6. Attribution and trademarks
|
||||
|
||||
Keep this license and applicable copyright notices with copies of the
|
||||
Software. Do not misrepresent a modified version as an official release.
|
||||
No trademark, branding, or endorsement rights are granted, except truthful
|
||||
identification of the Software and preservation of required notices.
|
||||
|
||||
7. Termination
|
||||
|
||||
Rights granted by this license terminate if you violate its terms. You must
|
||||
stop the violating use immediately. For a first violation, these rights are
|
||||
automatically reinstated if you fully cure it within 30 days after becoming
|
||||
aware of it. Otherwise reinstatement requires the Licensor's written
|
||||
permission. Termination does not revoke rights you independently hold under
|
||||
other licenses, including licenses for earlier releases.
|
||||
|
||||
8. Disclaimer and limitation of liability
|
||||
|
||||
To the extent permitted by law, the Software is provided as is, without
|
||||
warranties of any kind, including merchantability, fitness for a particular
|
||||
purpose, title, and non-infringement. The Licensor is not liable for claims,
|
||||
damages, or other liability arising from the Software or its use, whether
|
||||
in contract, tort, or otherwise. You are responsible for reviewing changes,
|
||||
protecting your data, and complying with your model providers' terms.
|
||||
|
||||
All rights not expressly granted are reserved.
|
||||
@@ -3,7 +3,7 @@
|
||||
<picture>
|
||||
<source media="(prefers-reduced-motion: reduce) and (prefers-color-scheme: dark)" srcset="assets/empryo-mote-dark.svg" />
|
||||
<source media="(prefers-reduced-motion: reduce)" srcset="assets/empryo-mote-light.svg" />
|
||||
<source media="(prefers-color-scheme: dark)" srcset="assets/epryo-mote-dark-normal.gif" />
|
||||
<source media="(prefers-color-scheme: dark)" srcset="assets/empryo-mote-dark-normal.gif" />
|
||||
<source media="(prefers-color-scheme: light)" srcset="assets/empryo-mote-light-normal.gif" />
|
||||
<img src="assets/empryo-mote-light-normal.gif" width="120" height="120" alt="Mote, the Empryo mascot" />
|
||||
</picture>
|
||||
@@ -25,6 +25,21 @@ Knows your code by heart.
|
||||
|
||||
</div>
|
||||
|
||||
<details>
|
||||
<summary>Watch the demo</summary>
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-reduced-motion: reduce) and (prefers-color-scheme: dark)" srcset="assets/empryo-demo-still-dark.webp" />
|
||||
<source media="(prefers-reduced-motion: reduce)" srcset="assets/empryo-demo-still-light.webp" />
|
||||
<source media="(prefers-color-scheme: dark)" srcset="assets/empryo-demo-dark.webp" />
|
||||
<source media="(prefers-color-scheme: light)" srcset="assets/empryo-demo-light.webp" />
|
||||
<img alt="Empryo maps a repository, follows its connections, edits code and shows the diff in desktop and terminal views" src="assets/empryo-demo-light.webp" width="880" />
|
||||
</picture>
|
||||
|
||||
[Full video, dark](assets/empryo-demo-dark.mp4) · [Full video, light](assets/empryo-demo-light.mp4)
|
||||
|
||||
</details>
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
@@ -67,9 +82,15 @@ One agent, the same map and memory, wherever you run it.
|
||||
</picture>
|
||||
</div>
|
||||
|
||||
## Open core
|
||||
## Public core and engine
|
||||
|
||||
This repository is the core and engine Empryo runs on, open source as SoulForge under its [license](LICENSE). The desktop app, the new surfaces and the newest features are Empryo's.
|
||||
This repository contains the public SoulForge v2 core and engine code under its [existing license](LICENSE). It is not the full source of Empryo v3; the current desktop app, new surfaces and newest features are developed privately.
|
||||
|
||||
## Empryo v3 usage
|
||||
|
||||
Empryo v3 is free for personal and internal business use, including company development, paid client work and headless CI. You can sell the work you create with it. Selling, hosting, wrapping or bundling Empryo itself as a commercial offering requires the owner's explicit prior written permission in a separate commercial license. Contact **[email protected]**.
|
||||
|
||||
The [Empryo v3 license](EMPRYO_V3_LICENSE.md) applies only to distributions supplied under those terms. It does not replace this repository's [SoulForge license](LICENSE), revoke earlier grants or change their existing conversion rights.
|
||||
|
||||
Bugs go to [Issues](https://github.com/proxysoul/soulforge/issues), ideas to [Discussions](https://github.com/proxysoul/soulforge/discussions).
|
||||
|
||||
|
||||
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 2.3 MiB |
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 2.3 MiB |
Binary file not shown.
|
After Width: | Height: | Size: 72 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 70 KiB |
@@ -0,0 +1,33 @@
|
||||
WEBVTT
|
||||
|
||||
00:00:00.000 --> 00:00:02.400
|
||||
Empryo. Knows your code by heart.
|
||||
|
||||
00:00:02.900 --> 00:00:07.900
|
||||
Desktop app. It maps your repo first.
|
||||
Files, symbols and imports, ranked. 171 files import loader.ts.
|
||||
|
||||
00:00:08.400 --> 00:00:13.400
|
||||
Terminal app. It knows what an edit will touch.
|
||||
186 files depend on tokens.ts, and themes.md usually changes with it.
|
||||
|
||||
00:00:13.900 --> 00:00:19.300
|
||||
Terminal app. It searches the map, then reads.
|
||||
One Genome search, 2 hits, then 24 lines of loader.ts instead of the whole file.
|
||||
|
||||
00:00:19.800 --> 00:00:25.600
|
||||
Desktop app. Every edit lands as a diff.
|
||||
Then it runs the tests for the code it just changed.
|
||||
|
||||
00:00:26.100 --> 00:00:31.500
|
||||
Terminal app. Same agent in your terminal.
|
||||
The diff, plus the test file that usually changes with loader.ts.
|
||||
|
||||
00:00:32.000 --> 00:00:39.000
|
||||
Knows your code by heart.
|
||||
Edits TypeScript and JavaScript by symbol, through the syntax tree.
|
||||
Asks language servers for definitions, references and callers.
|
||||
Remembers decisions and gotchas, per project.
|
||||
Desktop app, terminal, or headless in scripts and CI.
|
||||
Install: curl -fsSL https://empryo.com/install.sh | bash
|
||||
Docs: empryo.com/docs
|
||||
Reference in new issue
Block a user