@instructure/instui-cli

---

category: packages

instui-cli

   

A cli for working with Instructure UI packages.

Using npx

$ npx @instructure/instui-cli create component

Globally installing instui-cli

$ npm install -g @instructure/instui-cli

You now have access to instui commands

instui create component

Available commands

• create component | Create an Instructure UI component. DEPRECATED, will be removed in InstUI v9.
• create package | Create an Instructure UI package. DEPRECATED, will be removed in InstUI v9.
• create-from-template | Copy template source file or directory to a specified destination and replace variables with designated values. DEPRECATED, will be removed in InstUI v9.
• upgrade | Upgrades instructure-ui in a designated repository to the latest stable version including upgrading packages and applying codemods.
• upgrade-packages | Upgrade instructure-ui packages to the latest stable version.
• codemod | Apply instructure-ui codemods to source at a specified path.
• version | Return the current version of instui-cli and exit.

Documentation

For more documentation on available options and parameters for individual commands do:

instui <command> --help