tigyog-cli

0.13.2 • Public • Published

TigYog.app CLI (BETA!)

For context, see TigYog.app and the TigYog docs. For an example course being written with the TigYog CLI, see Eigenwhat?.

Installation and usage

$ npm install -g tigyog-cli  # Requires Node.js 16.11+
$ tigyog login my_session_token  # Get this from https://tigyog.app/account
$ mkdir my_course; cd my_course  # Create new directory for your course
$ tigyog init  # Initialize with starter course content
$ tigyog fmt  # Format your course, e.g. add identifiers
$ tigyog publish  # Push your course to TigYog.app and publish it

Publishing from git

You might want to publish your course every time you push to a git repository. If you're using GitHub, you can use GitHub Actions for this:

  1. On your GitHub repository, add a secret.
  2. Name the secret TY_SESSION and copy the value from your TigYog account page.
  3. Add a workflow file like this to your repository.

Configuration

This tool uses conf to store its config, including your session token. You can find this config at:

  • MacOS: ~/Library/Preferences/tigyog-nodejs/config.json
  • Windows: C:\Users\USERNAME\AppData\Roaming\tigyog-nodejs\Config\config.json

Planned features

If you need any of these, or have any other problems, email Jim or file a GitHub issue.

  • All TigYog block types. Still to do:

    • Images: dark mode strategy
    • Responses not immediately following buttons
    • Callout
  • API keys. Currently authenticates using session tokens taken from the browser. These expire after around 6 months.

Dependents (0)

Package Sidebar

Install

npm i tigyog-cli

Weekly Downloads

0

Version

0.13.2

License

none

Unpacked Size

37.4 kB

Total Files

20

Last publish

Collaborators

  • jameshfisher