Skip to content

command-reference.md

Latest commit

 

History

History
44 lines (31 loc) · 1.46 KB

command-reference.md

File metadata and controls

44 lines (31 loc) · 1.46 KB
Raw

Command reference

This page is a quick map of what commands exist and what they’re for.

For full help (including flags), use:

sampctl help
sampctl <command> --help

Server commands

There are no separate “server-only” commands in the current CLI.

You run a server by running a Pawn project:

  • sampctl ensure: download/update dependencies and runtime files
  • sampctl run [runtime-name]: build (if needed) and run your project as a server

Package commands

  • sampctl init: create a new project (pawn.json / pawn.yaml + folder layout)
  • sampctl install <dep...>: add dependency (writes to pawn.json / pawn.yaml)
  • sampctl uninstall <dep...>: remove dependency
  • sampctl ensure: ensure dependencies (and runtime files) are present
  • sampctl build [build-name]: compile the project
  • sampctl run [runtime-name]: compile (if needed) and run in a runtime
  • sampctl get <user/repo>: clone a GitHub package and ensure it
  • sampctl release: create a versioned package release

Templates

  • sampctl template make: create a template from a package
  • sampctl template build: build a file with a template
  • sampctl template run: run a file with a template

Other

  • sampctl version: show the sampctl version
  • sampctl config: view/change global sampctl config
  • sampctl compiler list: list compiler configurations
  • sampctl completion: print shell completion script
  • sampctl docs: print auto-generated markdown docs (advanced)