Skip to content

Commit

Permalink
Update readme to be in line with docs (#31)
Browse files Browse the repository at this point in the history
  • Loading branch information
GAllen98 authored Jan 10, 2025
1 parent 147c2ce commit 3661720
Showing 1 changed file with 58 additions and 9 deletions.
67 changes: 58 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,19 @@ npx make-agent dev -p 3000

Currently, the CLI supports the following command:

1. **dev**: Make your AI agent discoverable and register the plugin
1. ### **`dev`**: Make your AI agent discoverable and register the plugin

Usage:
```bash
npx make-agent dev -p <port_number>
```

Options:
- `-p, --port <number>`: Specify the local port to expose (required)
- `-p, --port <number>`: Specify the local port to expose (optional). \\

2. **deploy**: Deploy your AI agent, making it discoverable and registering it as a plugin
If no port is provided, the command will search for a node instance running in the current directory and assume its port.

2. ### **`deploy`**: Deploy your AI agent, making it discoverable and registering it as a plugin

Usage:
```bash
Expand All @@ -41,15 +43,62 @@ Currently, the CLI supports the following command:

If no URL is provided, the command will attempt to determine the deployed URL automatically.

### Future Commands
3. ### **`register`**: Register a new plugin with a URL

Usage:
```bash
npx make-agent register [options]
```

Options:
- `-u, --url <url>`: Specify the deployment URL (optional)

If no URL is provided, the command will attempt to determine the deployed URL automatically.

4. ### **`update`**: Update an existing AI agent plugin

Usage:
```bash
npx make-agent update [options]
```

The CLI is designed to support additional commands in the future, such as:
Options:
- `-u, --url <url>`: Specify the deployment URL (optional)

- `register`: For registering AI agents
- `update`: For updating existing AI agents
- `delete`: For removing AI agents
If no URL is provided, the command will attempt to determine the deployed URL automatically.
5. ### **`contract`**: Scaffold a basic agent from a NEAR contract that has an ABI
Usage:
```bash
npx make-agent contract
```
You will be prompted to select a contractId, add a description with instructions on how the agent should use the contract and an output directory

6. ### **`delete`**: Delete your AI agent plugin

Usage:
```bash
npx make-agent delete [options]
```

Options:
- `-u, --url <url>`: Specify the deployment URL (optional)

If no URL is provided, the command will attempt to determine the deployed URL automatically.

7. ### **`verify`**: Request your plugin's verification

Usage:
```bash
npx make-agent verify -u <url> -e <email> -r <repoUrl> -v <versionNumber>
```

Options:
- `-u, --url <url>`: (required) Specify the url of the deployed plugin
- `-e, --email <email>`: (required) Provide an email so we can contact you regarding the verification process
- `-r, --repo <repoUrl>`: (required) To verify a plugin we need the url for a public repository containing the plugin's code
- `-v, --version <versionNumber>`: (optional) Specify the version of the plugin in case of an update


These commands are currently commented out in the code and will be implemented in future versions.

## Development

Expand Down

0 comments on commit 3661720

Please sign in to comment.