Skip to content

Usage.md

Latest commit

 

History

History
144 lines (75 loc) · 3.26 KB

Usage.md

File metadata and controls

144 lines (75 loc) · 3.26 KB
Raw

Command-Line Help for oseda

This document contains the help content for the oseda command-line program.

Command Overview:

oseda

oseda project scafolding CLI

Usage: oseda <COMMAND>

Subcommands:
  • init — Initialize a new Oseda project in the working directory
  • run — Run the Oseda project in the working directory
  • check — Check the Oseda project in the working directory for common errors
  • deploy — Deploy your Oseda project to github to add to oseda.net
  • fork — Fork the library repository to submit your course
  • export — Export the Oseda project to a PDF file This will install the npm package decktape This relies on a chromium backend, as a result, it may take a while to run
  • update — Update the oseda binary from crates.io
  • dev — Run an Oseda project in dev mode, with hot-reloading

oseda init

Initialize a new Oseda project in the working directory

Usage: oseda init [OPTIONS]

Options:
  • --title <TITLE> — Project Title
  • --tags <TAG1,TAG2,...> — Project Tags [e.g: ComputerScience,Engineering,...]
  • --color <COLOR> — Project Color [e.g: Red]
  • --template <FORMAT> — Project Template Format [HTML | Markdown]
  • --license <SPDX_ID> — OSI License SPDX identifier [e.g: MIT]
  • --description <TEXT> — Project Description

oseda run

Run the Oseda project in the working directory

Usage: oseda run

oseda check

Check the Oseda project in the working directory for common errors

Usage: oseda check [OPTIONS]

Options:

  • --port <PORT> — Port to check for the Oseda project on This is only useful if you have changed the default port that Oseda projects run on my default (3000)

    Default value: 3000

oseda deploy

Deploy your Oseda project to github to add to oseda.net

Usage: oseda deploy [OPTIONS] <FORK_URL>

Arguments:
  • <FORK_URL> — URL to fork of oseda-lib GitHub repository
Options:
  • --quiet — Run in quiet mode (e.g. do not open PR in browser)

oseda fork

Fork the library repository to submit your course

Usage: oseda fork

oseda export

Export the Oseda project to a PDF file This will install the npm package decktape This relies on a chromium backend, as a result, it may take a while to run

Usage: oseda export [OPTIONS] [OUTPUT]

Arguments:
  • <OUTPUT> — String name of the output PDF file
Options:

  • --port <PORT> — Port the project runs on

    Default value: 3000

oseda update

Update the oseda binary from crates.io

Usage: oseda update

oseda dev

Run an Oseda project in dev mode, with hot-reloading

Usage: oseda dev [OPTIONS]

Options:

  • --port <PORT> — Port to run the vite dev server on

    Default value: 3000

This document was generated automatically by clap-markdown.