Skip to content

Commit 0f88b25

Browse files
committed
Add updated README
1 parent 5599884 commit 0f88b25

File tree

2 files changed

+97
-5
lines changed

2 files changed

+97
-5
lines changed

README.md

+82-5
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
11
<div align="center">
2-
<img src=".github/Agentuity.png" alt="Agentuity" width="100"/>
3-
</div>
4-
2+
<img src=".github/Agentuity.png" alt="Agentuity" width="100"/> <br/>
3+
<strong>Build Agents, Not Infrastructure</strong> <br/>
54
<br />
5+
<a href="https://github.com/agentuity/cli/releases"><img alt="Release version" src="https://img.shields.io/github/v/release/agentuity/cli"></a>
6+
<a href="https://github.com/agentuity/sdk-js/blob/main/README.md"><img alt="License" src="https://badgen.now.sh/badge/license/Apache-2.0"></a>
7+
<a href="https://discord.gg/vtn3hgUfuc"><img alt="Join the community on Discord" src="https://img.shields.io/discord/1332974865371758646.svg?style=flat"></a>
8+
</div>
9+
</div>
610

711
# Agentuity CLI
812

913
> [!WARNING]
1014
> This repository is under heavy development and it is not yet stable or ready for use.
1115
12-
The CLI for the Agentuity Agent Cloud Platform.
16+
The command line tools for the Agentuity Agent Cloud Platform. These tools are used to build, manage, and deploy agents to the Agentuity platform.
1317

1418
## Installation
1519

@@ -27,6 +31,79 @@ For other platforms, please download the binary from the [Releases](https://gith
2731
agentuity --help
2832
```
2933

34+
## Usage
35+
36+
The Agentuity CLI provides a comprehensive set of commands to help you build, manage, and deploy agents. Here's an overview of the available commands:
37+
38+
### Basic Commands
39+
40+
```bash
41+
# Display help information
42+
agentuity --help
43+
44+
# Check the CLI version
45+
agentuity version
46+
47+
# Login to the Agentuity Cloud Platform
48+
agentuity login
49+
```
50+
51+
### Project Management
52+
53+
```bash
54+
# Create a new project
55+
agentuity create [name]
56+
# or
57+
agentuity project create [name] [--dir <directory>] [--provider <provider>]
58+
59+
# List all projects
60+
agentuity project list
61+
62+
# Delete one or more projects
63+
agentuity project delete
64+
```
65+
66+
### Agent Management
67+
68+
```bash
69+
# Create a new agent
70+
agentuity agent create
71+
72+
# List all agents in the project
73+
agentuity agent list
74+
75+
# Delete one or more agents
76+
agentuity agent delete
77+
```
78+
79+
### Development and Deployment
80+
81+
```bash
82+
# Run the development server
83+
agentuity run
84+
85+
# Deploy your project to the cloud
86+
agentuity deploy
87+
# or
88+
agentuity cloud deploy [--dir <directory>]
89+
```
90+
91+
### Other Commands
92+
93+
```bash
94+
# Environment related commands
95+
agentuity env
96+
97+
# Authentication and authorization
98+
agentuity auth
99+
```
100+
101+
For more detailed information about any command, you can use:
102+
103+
```bash
104+
agentuity [command] --help
105+
```
106+
30107
## License
31108

32-
This project is licensed under the Apache 2.0 Public License. Please see the [LICENSE](LICENSE.md) file for details.
109+
See the [LICENSE](LICENSE.md) file for details.

biome.json

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
3+
"formatter": {
4+
"enabled": true,
5+
"ignore": ["./internal/templates/data/**"]
6+
},
7+
"linter": {
8+
"enabled": true,
9+
"ignore": ["./internal/templates/data/**"]
10+
},
11+
"organizeImports": {
12+
"enabled": true,
13+
"ignore": ["./internal/templates/data/**"]
14+
}
15+
}

0 commit comments

Comments
 (0)