Skip to content

Documentation: List available commands #1164

Open
@samjamead

Description

@samjamead

Hiya – a few days ago I was fishing around in the Slack community group asking about the available commands for local development. Swiftly resolved (thank you Fabian and Fil 🙏 ), I tried to open a PR to add some documentation listing the commands. Alas, I don't have write access to the repo. Feel free to incorporate. It feels like the bottom of getting-started.md is an appropriate place.

Useful commands

A list of available commands is available from the command line by running:

npm run observable help

Or with yarn:

yarn observable help

Which should yeild the following list:

create        create a new project from a template       
preview       start the preview server                   
build         generate a static site                     
login         sign-in to Observable                      
logout        sign-out of Observable                     
deploy        deploy a project to Observable             
whoami        check authentication status                
convert       convert an Observable notebook to Markdown 
help          print usage information                    
version       print the version                          

The usage pattern is:

npm run observable «command»

Or with yarn:

yarn observable «command»

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions