@cto.ai/tux

CTO.ai Terminal User Experience Library

Usage no npm install needed!

<script type="module">
  import ctoAiTux from 'https://cdn.skypack.dev/@cto.ai/tux';
</script>

README

@cto.ai/tux

CTO.ai Terminal User Experience Library

Status - WIP

API

This is a native ESM module.

spinner

ora spinner instance.

render(message)

Render a message using chalk templates.

theme(mode)

Change the color theme, possible modes are dark and light.

Engines

  • Node 12.4+
  • Node 14.0+

Development

Test:

npm test

Visual coverage report (run after test):

npm run cov

Lint:

npm run lint

Autoformat:

npm run lint -- --fix

Releasing

For mainline releases:

npm version <major|minor|patch>
git push --follow-tags

For prereleases:

npm version prerelease
git push --follow-tags

License

MIT