You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
asciinema is probably the best way to demonstrate the usage of any given command. it's files are stored in asciicast v2 format
add support for asciicast_url to the TOML ingestion
100% optional
can be a path /foo/bar/baz.cast
can be a file protocol path file://foo/bar/baz.cast
NO (maybe later) converted to /foo/bar/baz.cast
can be an url https://foo/bar/baz.cast
expected mime type is application/x-asciicast but we shouldn't enforce that. I'm sure a lot of servers get it wrong.
NO: if an asciicast_url is found in a toml it will check if asciinema support has been enabled, and .... ask the user if they want it enabled? ??? or just store the data? just store the data
add support for adding .cast files separately
clu add path/to/my.cast
name must match command already in the db
add playback support
NO: only supported if asciinema support has been enabled
add clu demo <command> functionality (see Playback below)
add clu list demos functionality (see Playback below)
Adding Demos
For now, clu add will only support local paths /path/to/my.cast
You can only add a web url via the .toml (for now).
Playback support
No clue how this should work since most commands probably won't have casts.
At the very least there should be an line in the clu show <command> indicating that a "demo" is available.
I'm thinking something like clu demo <command> and it invokes asciinema play /path/to/my.cast if there's a demo (asciicast) for the specified command.
Skipped: However, IF the asciicast_url is an http(s) url it'll just callopen <asciicast_url> and load the web page.
maybe there's a clu demos command (plural demoS) which lists all the commands that have demos.
I'm open to suggestions .
Side Note / Future Thinking
Once we have support for markdown export we'll be able to link to an asciicast to demonstrate the use of the command.
This will likely have to wait until we have the ability to export a "readme" type page for every command.
I think we're going to end up in a situation where we're basically just generating pages for some static site generator. A custom index and then an individual page for every command. ... would be cool.
The text was updated successfully, but these errors were encountered:
asciinema is probably the best way to demonstrate the usage of any given command. it's files are stored in asciicast v2 format
asciicast_url
to the TOML ingestion/foo/bar/baz.cast
file://foo/bar/baz.cast
converted to/foo/bar/baz.cast
https://foo/bar/baz.cast
application/x-asciicast
but we shouldn't enforce that. I'm sure a lot of servers get it wrong.if anjust store the dataasciicast_url
is found in atoml
it will check ifasciinema
support has been enabled, and .... ask the user if they want it enabled? ??? or just store the data?.cast
files separatelyclu add path/to/my.cast
only supported ifasciinema
support has been enabledclu demo <command>
functionality (see Playback below)clu list demos
functionality (see Playback below)Adding Demos
For now,
clu add
will only support local paths/path/to/my.cast
You can only add a web url via the
.toml
(for now).Playback support
No clue how this should work since most commands probably won't have casts.
At the very least there should be an line in the
clu show <command>
indicating that a "demo" is available.I'm thinking something like
clu demo <command>
and it invokesasciinema play /path/to/my.cast
if there's a demo (asciicast) for the specified command.Skipped: However, IF the
asciicast_url
is an http(s) url it'll just callopen <asciicast_url>
and load the web page.👆 we can add that later.
If there isn't one it should say something like
maybe there's a
clu demos
command (plural demoS) which lists all the commands that have demos.I'm open to suggestions .
Side Note / Future Thinking
Once we have support for markdown export we'll be able to link to an asciicast to demonstrate the use of the command.
This will likely have to wait until we have the ability to export a "readme" type page for every command.
I think we're going to end up in a situation where we're basically just generating pages for some static site generator. A custom index and then an individual page for every command. ... would be cool.
The text was updated successfully, but these errors were encountered: