-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added CLI and other change improvements.
- Loading branch information
1 parent
3c92872
commit 3178db9
Showing
51 changed files
with
1,049 additions
and
23 deletions.
There are no files selected for viewing
This file contains 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 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 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 |
---|---|---|
@@ -0,0 +1 @@ | ||
{} |
This file contains 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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# @chatbotkit/cli | ||
|
||
## 1.5.0 | ||
|
||
### Minor Changes | ||
|
||
- 10f0d94: Added initial version of the cli tools. |
This file contains 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 |
---|---|---|
@@ -0,0 +1,45 @@ | ||
[![Follow on Twitter](https://img.shields.io/twitter/follow/chatbotkit.svg?logo=twitter)](https://twitter.com/chatbotkit) | ||
[![ChatBotKit](https://img.shields.io/badge/credits-ChatBotKit-blue.svg)](https://chatbotkit.com) | ||
[![NPM](https://img.shields.io/npm/v/@chatbotkit/cli.svg)](https://www.npmjs.com/package/@chatbotkit/cli) | ||
|
||
# ChatBotKit CLI | ||
|
||
The ChatBotKit CLI is a command-line interface for the ChatBotKit SDK. It provides a set of commands to help you manage your ChatBotKit projects. | ||
|
||
## Getting Started | ||
|
||
To begin using the ChatBotKit CLI, follow these steps: | ||
|
||
1. **Installation**: Add the SDK to your project using npm: | ||
|
||
```bash | ||
npm install --global @chatbotkit/cli | ||
``` | ||
|
||
2. **Help**: Get help on the available commands: | ||
|
||
```bash | ||
cbk --help | ||
``` | ||
|
||
3. **Usage**: Use the CLI to interact with ChatBotKit: | ||
|
||
Keep in mind that you will need to authenticate with your ChatBotKit token first. | ||
|
||
```bash | ||
export CHATBOTKIT_API_TOKEN=<your token here> | ||
``` | ||
|
||
Then you can use the CLI to interact with ChatBotKit: | ||
|
||
```bash | ||
cbk api conversation list | ||
``` | ||
|
||
## Documentation | ||
|
||
For comprehensive information about the ChatBotKit CLI SDK, including detailed documentation on its functionalities, helper methods, and configuration options, please visit our [type documentation page](https://chatbotkit.github.io/node-sdk/modules/_chatbotkit_cli.html). | ||
|
||
## Contributing | ||
|
||
If you find a bug or would like to contribute to the ChatBotKit SDK, please open an issue or submit a pull request on the [official GitHub repository](https://github.com/chatbotkit/node-sdk). |
This file contains 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 |
---|---|---|
@@ -0,0 +1,4 @@ | ||
import cbk from '../src/index.js' | ||
import { printError } from '../src/output.js' | ||
|
||
cbk().catch(printError) |
This file contains 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 |
---|---|---|
@@ -0,0 +1 @@ | ||
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. |
This file contains 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 |
---|---|---|
@@ -0,0 +1,33 @@ | ||
@chatbotkit/cli / [Modules](modules.md) | ||
|
||
[![Follow on Twitter](https://img.shields.io/twitter/follow/chatbotkit.svg?logo=twitter)](https://twitter.com/chatbotkit) | ||
[![ChatBotKit](https://img.shields.io/badge/credits-ChatBotKit-blue.svg)](https://chatbotkit.com) | ||
[![NPM](https://img.shields.io/npm/v/@chatbotkit/cli.svg)](https://www.npmjs.com/package/@chatbotkit/cli) | ||
|
||
# ChatBotKit CLI | ||
|
||
The ChatBotKit CLI is a command-line interface for the ChatBotKit SDK. It provides a set of commands to help you manage your ChatBotKit projects. | ||
|
||
## Getting Started | ||
|
||
To begin using the ChatBotKit CLI, follow these steps: | ||
|
||
1. **Installation**: Add the SDK to your project using npm: | ||
|
||
```bash | ||
npm install --global @chatbotkit/cli | ||
``` | ||
|
||
2. **Usage**: Get help on the available commands: | ||
|
||
```bash | ||
cbk --help | ||
``` | ||
|
||
## Documentation | ||
|
||
For comprehensive information about the ChatBotKit CLI SDK, including detailed documentation on its functionalities, helper methods, and configuration options, please visit our [type documentation page](https://chatbotkit.github.io/node-sdk/modules/_chatbotkit_cli.html). | ||
|
||
## Contributing | ||
|
||
If you find a bug or would like to contribute to the ChatBotKit SDK, please open an issue or submit a pull request on the [official GitHub repository](https://github.com/chatbotkit/node-sdk). |
This file contains 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 |
---|---|---|
@@ -0,0 +1,10 @@ | ||
[@chatbotkit/cli](README.md) / Modules | ||
|
||
# @chatbotkit/cli | ||
|
||
## Table of contents | ||
|
||
### Modules | ||
|
||
- [env](modules/env.md) | ||
- [output](modules/output.md) |
This file contains 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 |
---|---|---|
@@ -0,0 +1,40 @@ | ||
[@chatbotkit/cli](../README.md) / [Modules](../modules.md) / env | ||
|
||
# Module: env | ||
|
||
## Table of contents | ||
|
||
### Functions | ||
|
||
- [getRUNAS\_USERID](env.md#getrunas_userid) | ||
- [getSECRET](env.md#getsecret) | ||
|
||
## Functions | ||
|
||
### getRUNAS\_USERID | ||
|
||
▸ **getRUNAS_USERID**(): `string` | ||
|
||
#### Returns | ||
|
||
`string` | ||
|
||
#### Defined in | ||
|
||
[env.js:16](https://github.com/chatbotkit/node-sdk/blob/main/packages/cli/src/env.js#L16) | ||
|
||
___ | ||
|
||
### getSECRET | ||
|
||
▸ **getSECRET**(): `string` | ||
|
||
#### Returns | ||
|
||
`string` | ||
|
||
**`Throws`** | ||
|
||
#### Defined in | ||
|
||
[env.js:5](https://github.com/chatbotkit/node-sdk/blob/main/packages/cli/src/env.js#L5) |
This file contains 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 |
---|---|---|
@@ -0,0 +1,50 @@ | ||
[@chatbotkit/cli](../README.md) / [Modules](../modules.md) / output | ||
|
||
# Module: output | ||
|
||
## Table of contents | ||
|
||
### Functions | ||
|
||
- [print](output.md#print) | ||
- [printError](output.md#printerror) | ||
|
||
## Functions | ||
|
||
|
||
▸ **print**(`input`): `void` | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `input` | `any` | | ||
|
||
#### Returns | ||
|
||
`void` | ||
|
||
#### Defined in | ||
|
||
[output.js:13](https://github.com/chatbotkit/node-sdk/blob/main/packages/cli/src/output.js#L13) | ||
|
||
___ | ||
|
||
### printError | ||
|
||
▸ **printError**(`error`): `void` | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `error` | `any` | | ||
|
||
#### Returns | ||
|
||
`void` | ||
|
||
#### Defined in | ||
|
||
[output.js:49](https://github.com/chatbotkit/node-sdk/blob/main/packages/cli/src/output.js#L49) |
Oops, something went wrong.