📜
PaperScript Docs
  • Welcome to PaperScript
  • Quick Start Guide
  • Syntax Reference
  • Feature Matrix
  • Feature Deep Dive
  • VSCode Extension
  • The Preprocessor
  • The project.yaml File
  • PaperScript CLI
    • Installing
    • Usage
  • Fallout 4 Support
  • Proposals
    • Naive Optimizations
  • Miscellaneous
    • Complete Example Scripts
Powered by GitBook
On this page
  • The PaperScript CLI
  • init
  • build
  • transpile
  • version
Edit on GitHub
Export as PDF
  1. PaperScript CLI

Usage

The PaperScript CLI

USAGE:
    PaperScript.Cli.dll [OPTIONS] <COMMAND>

OPTIONS:
    -h, --help    Prints help information

COMMANDS:
    build        build a project (requires a project.yaml)
    transpile    transpiles a single file
    init         creates a new project.yaml
    version      prints version information

init

Creates a new PaperScript project, sets up the directory structure and creates a project.yaml file in the current directory.

USAGE:
    paperscript init [OPTIONS]

OPTIONS:
    -h, --help     Prints help information
    -f, --force    Force creating a project in a non-dempty directory

build

Builds a project in the current directory. Requires a valid project.yaml file.

USAGE:
    paperscript build [OPTIONS]

OPTIONS:
    -h, --help          Prints help information
    -n, --no-compile    do not run the papyrus compiler

transpile

Transpiles a single file from PaperScript to Papyrus.

USAGE:
    paperscript transpile [INPUT FILE] [OPTIONS]

ARGUMENTS:
    [INPUT FILE]

OPTIONS:
    -h, --help                    Prints help information
    -o, --output <OUTPUT_FILE>
    -s, --stdout                  Output to STDOUT instead of a file

version

Prints out version information for the CLI.

USAGE:
    paperscript version [OPTIONS]

OPTIONS:
    -h, --help    Prints help information
PreviousInstallingNextFallout 4 Support

Last updated 2 days ago