@ibm-adw/skill-toolkit

1.0.15 • Public • Published

Developing your own skills with IBM Automation Digital Worker Skill Toolkit

Developers can create their own skills from scratch to enrich the IBM Automation Digital Worker catalog beyond what is currently available.

This toolkit contains the following things:

  • A starter kit, which creates the file structure and templates that you need to create a skill.
  • A test kit, which allows you to test the code that you are implementing as you go along.

For more details, read the IBM Cloud Pak for Automation 20.0.2 documentation about Developing your own skills with the skill toolkit.

Supported browsers are Chrome, Edge, Firefox and Safari.

Compatibilities

This table shows the compatibilities between versions of the skill toolkit and versions of IBM Cloud Pak for Automation.

Toolkit Version IBM Cloud Pak for Automation Version
1.0.15 20.0.2
1.0.12 20.0.1
1.0.0 19.0.3

Prerequisites

The toolkit is available as an NPM module, which you must install with the following command:

npm i @ibm-adw/skill-toolkit -g -s

Launch the starter kit

To launch the starter kit and generate a skill sample, type the following command:

npx adw-create-skill MySkill

DEPRECATED: npx create-skill MySkill

Test your skill

You can use the test kit that is also provided to test your changes and see how it would look like in the user interface.

In the command-line tool, you must start the client and the server.

To start the server, type the following command: npx adw-launch-server MySkill [SERVER_PORT]

[SERVER_PORT] is the port where the skill endpoint is available. If not specified, the default is 8888.

DEPRECATED: npx launch-server MySkill [SERVER_PORT]

To start the client, open a new terminal window and type the following command: npx adw-launch-client [CLIENT_PORT] [SERVER_PORT]

[CLIENT_PORT] is the port where the test kit client application is running. If not specified, the default is 3000.

DEPRECATED: npx launch-client [CLIENT_PORT] [SERVER_PORT]

Deploy your skill

When you are satisfied with your skill and want to integrate it in Digital Worker, you must deploy your skill:

  • Type the following command to create a .tgz archive inside your repository
cd MySkill
npm pack
  • Open your instance of Digital Worker and go to the skill catalog.
  • Click Import and select the .tgz archive.

License

APACHE LICENSE, VERSION 2.0

Package Sidebar

Install

npm i @ibm-adw/skill-toolkit

Weekly Downloads

2

Version

1.0.15

License

Apache-2.0

Unpacked Size

1.04 MB

Total Files

118

Last publish

Collaborators

  • baiwread