-
Notifications
You must be signed in to change notification settings - Fork 2
docs: sync CLI reference and intro with codebase #154
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
54 changes: 41 additions & 13 deletions
54
clients/web/apps/docs/src/content/docs/en/intro/introduction.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,55 @@ | ||
| --- | ||
| title: Introduction | ||
| description: Welcome to the Corvus Agent Platform documentation. | ||
| --- | ||
|
|
||
| # Welcome to Corvus | ||
|
|
||
| Corvus is a powerful, modular system designed for building scalable applications. This documentation will help you understand, install, and use its core capabilities effectively. | ||
| **Corvus** is a highly extensible, multi-interface agentic platform designed to bridge the gap between AI autonomy and human supervision. Built with a robust **Kotlin Multiplatform** foundation and powered by a high-performance **Rust** runtime, Corvus provides a secure, sandboxed environment for AI agents to perform complex, multi-step tasks. | ||
|
|
||
| ## Key Features | ||
|  | ||
|
|
||
| - **Modular Design:** Easily configurable and scalable. | ||
| - **Security-First Approach:** Built with secure defaults and best practices. | ||
| - **Cross-Platform:** Supports Android, iOS, Desktop, and Web setups. | ||
| ## ✨ Features | ||
|
|
||
| ## Getting Started | ||
| - **Multi-Interface Support**: Interact with Corvus via CLI, a Compose Multiplatform Desktop app, or a web-based dashboard. | ||
| - **Always-On Autonomy**: A daemon mode for long-running agents that can handle background tasks and persistent orchestration. | ||
| - **Secure Sandboxing**: Execute dangerous commands safely within isolated Docker containers or restricted native runtimes. | ||
| - **Standardized Identity (AIEOS)**: Support for AIEOS v1.1, allowing for portable and model-agnostic AI personas. | ||
| - **Hybrid Memory Model**: Pluggable memory backends including SQLite, Neo4j, and SurrealDB for high-context retrieval. | ||
| - **Rich Integrations**: First-class support for WhatsApp (via Meta Cloud API), git, npm, cargo, and more. | ||
|
|
||
| - **Setup Instructions:** Follow the [Getting Started](../guides/getting-started/) guide to set up the project. | ||
| - **Architecture Overview:** Understand the [system architecture](../guides/architecture/). | ||
| - **Feature Overview:** Explore the [features](../guides/features/). | ||
| ## 🛠️ Tech Stack | ||
|
|
||
| - **Core Logic**: [Kotlin Multiplatform (KMP)](https://kotlinlang.org/docs/multiplatform.html) | ||
| - **Agent Runtime**: [Rust](https://www.rust-lang.org/) (High-performance sidecars and CLI) | ||
| - **Desktop UI**: [Compose Multiplatform](https://www.jetbrains.com/lp/compose-multiplatform/) | ||
| - **Web Stack**: [Astro](https://astro.build/), [Vue 3](https://vuejs.org/), and [Tailwind CSS](https://tailwindcss.com/docs) | ||
| - **Documentation**: [Starlight](https://starlight.astro.build/) | ||
| - **Build System**: [Gradle](https://gradle.org/) & [Makefile](https://www.gnu.org/software/make/) | ||
|
|
||
| ## 📂 Project Structure | ||
|
|
||
| This repository is organized as a monorepo: | ||
|
|
||
| ```text | ||
| corvus/ | ||
| ├── clients/ | ||
| │ ├── agent-runtime/ # High-performance Rust Agent Core & CLI | ||
| │ ├── composeApp/ # Shared UI logic for Desktop/Mobile | ||
| │ ├── web/ # Web monorepo (Docs, Dashboard, Marketing) | ||
| │ ├── androidApp/ # Android specific wrapper | ||
| │ └── iosApp/ # iOS specific wrapper | ||
| ├── modules/ | ||
| │ └── agent-core-kmp/ # Core Kotlin Multiplatform logic & contracts | ||
| ├── dev/ # Local development environment (Docker/Sandbox) | ||
| ├── gradle/ # Build logic and configurations | ||
| └── Makefile # Standard entry point for development tasks | ||
| ``` | ||
|
|
||
| ## Next Steps | ||
|
|
||
| Dive deeper into: | ||
| Ready to get started? | ||
|
|
||
| - [Configuration and Customization](../guides/configuration/) | ||
| - [Development Workflow](../guides/development/) | ||
| - [Release Process](../guides/release/) | ||
| - **[Getting Started](../guides/getting-started/)**: Install and run your first agent. | ||
| - **[CLI Reference](../guides/cli-reference/)**: Master the command line interface. | ||
| - **[Architecture](../guides/architecture/)**: Understand the system design. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
54 changes: 41 additions & 13 deletions
54
clients/web/apps/docs/src/content/docs/es/intro/introduction.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,55 @@ | ||
| --- | ||
| title: Introducción | ||
| description: Bienvenido a la documentación de la Plataforma de Agentes Corvus. | ||
| --- | ||
|
|
||
| # Bienvenido a Corvus | ||
|
|
||
| Corvus es un sistema modular y potente diseñado para construir aplicaciones escalables. Esta documentación te ayudará a comprender, instalar y usar sus capacidades principales de manera efectiva. | ||
| **Corvus** es una plataforma agéntica altamente extensible y multi-interfaz diseñada para cerrar la brecha entre la autonomía de la IA y la supervisión humana. Construida con una base robusta en **Kotlin Multiplatform** e impulsada por un runtime de alto rendimiento en **Rust**, Corvus proporciona un entorno seguro y aislado (sandboxed) para que los agentes de IA realicen tareas complejas de múltiples pasos. | ||
|
|
||
| ## Características Clave | ||
|  | ||
|
|
||
| - **Diseño Modular:** Fácilmente configurable y escalable. | ||
| - **Enfoque de Seguridad Primero:** Construido con configuraciones seguras y buenas prácticas. | ||
| - **Multiplataforma:** Compatible con Android, iOS, Escritorio y Web. | ||
| ## ✨ Características | ||
|
|
||
| ## Primeros Pasos | ||
| - **Soporte Multi-Interfaz**: Interactúa con Corvus a través de la CLI, una aplicación de escritorio Compose Multiplatform o un panel de control web. | ||
| - **Autonomía Siempre Activa**: Un modo demonio para agentes de larga duración que pueden manejar tareas en segundo plano y orquestación persistente. | ||
| - **Sandboxing Seguro**: Ejecuta comandos peligrosos de forma segura dentro de contenedores Docker aislados o runtimes nativos restringidos. | ||
| - **Identidad Estandarizada (AIEOS)**: Soporte para AIEOS v1.1, permitiendo personas de IA portátiles y agnósticas al modelo. | ||
| - **Modelo de Memoria Híbrido**: Backends de memoria conectables, incluyendo SQLite, Neo4j y SurrealDB para recuperación de alto contexto. | ||
| - **Integraciones Ricas**: Soporte de primera clase para WhatsApp (vía Meta Cloud API), git, npm, cargo y más. | ||
|
|
||
| - **Instrucciones de Configuración:** Sigue la guía de [Primeros Pasos](../guides/getting-started/) para configurar el proyecto. | ||
| - **Resumen de Arquitectura:** Comprende la [arquitectura del sistema](../guides/architecture/). | ||
| - **Descripción de Funcionalidades:** Explora las [funcionalidades](../guides/features/). | ||
| ## 🛠️ Pila tecnológica | ||
|
|
||
| - **Núcleo de la lógica**: [Kotlin Multiplatform (KMP)](https://kotlinlang.org/docs/multiplatform.html) | ||
| - **Runtime de Agente**: [Rust](https://www.rust-lang.org/) (Sidecars de alto rendimiento y CLI) | ||
| - **UI de Escritorio**: [Compose Multiplatform](https://www.jetbrains.com/lp/compose-multiplatform/) | ||
| - **Pila web**: [Astro](https://astro.build/), [Vue 3](https://vuejs.org/) y [Tailwind CSS](https://tailwindcss.com/docs) | ||
| - **Documentación**: [Starlight](https://starlight.astro.build/) | ||
| - **Sistema de construcción**: [Gradle](https://gradle.org/) y [Makefile](https://www.gnu.org/software/make/) | ||
|
|
||
| ## 📂 Estructura del Proyecto | ||
|
|
||
| Este repositorio está organizado como un monorepo: | ||
|
|
||
| ```text | ||
| corvus/ | ||
| ├── clients/ | ||
| │ ├── agent-runtime/ # Núcleo del Agente en Rust de alto rendimiento y CLI | ||
| │ ├── composeApp/ # Lógica de UI compartida para Escritorio/Móvil | ||
| │ ├── web/ # Monorepo Web (Docs, Dashboard, Marketing) | ||
| │ ├── androidApp/ # Wrapper específico para Android | ||
| │ └── iosApp/ # Wrapper específico para iOS | ||
| ├── modules/ | ||
| │ └── agent-core-kmp/ # Lógica core en Kotlin Multiplatform y contratos | ||
| ├── dev/ # Entorno de desarrollo local (Docker/Sandbox) | ||
| ├── gradle/ # Lógica de construcción y configuraciones | ||
| └── Makefile # Punto de entrada estándar para tareas de desarrollo | ||
| ``` | ||
|
|
||
| ## Siguientes Pasos | ||
|
|
||
| Profundiza en: | ||
| ¿Listo para empezar? | ||
|
|
||
| - [Configuración y Personalización](../guides/configuration/) | ||
| - [Flujo de Trabajo de Desarrollo](../guides/development/) | ||
| - [Proceso de Lanzamiento](../guides/release/) | ||
| - **[Primeros Pasos](../guides/getting-started/)**: Instala y ejecuta tu primer agente. | ||
| - **[Referencia de la CLI](../guides/cli-reference/)**: Domina la interfaz de línea de comandos. | ||
| - **[Arquitectura](../guides/architecture/)**: Comprende el diseño del sistema. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.