Commands

Commands

One menu for everything, and one command for each action, in English or Portuguese.

The command line is the way to go for people who write in Obsidian and want to build and publish the site without Blup Studio. Install it by following Installation.

Running just blup opens the menu: preview, publish, customize, sync, convert links, switch sites, create another one and language. It’s the easiest way.

Blup in the terminal

Each action has a command

EnglishPortugueseWhat it does
blup newblup novoCreates a new site
blup previewblup verOpens the preview in the browser
blup publishblup publicarPuts the site online
blup customizeblup personalizarMenu, sections, social links, logo, favicon, author, general password and comments
blup syncblup sincronizarKeeps the notes in a private GitHub repository
blup convertblup converterSwaps [[wikilinks]] for standard links
blup buildblup gerarBuilds the site into public/, with no questions
blup languageblup idiomaChanges Blup’s language
blup updateblup atualizarUpdates Blup
blup versionblup versionShows the version
blup helpblup --helpShows the help

More than one site

Blup remembers every site you created. In the menu, Switch to another site picks another one. With commands, pass the site’s folder: blup publish ~/Sites/my-site.

No questions

blup build asks nothing: good for scripts and automations. The site ends up in the public folder inside the site’s folder.

Site inside a subfolder

Want the docs at mysite.com/bento/, next to a landing page at the root? Build the site for that address and copy it into the landing page’s folder:

blup build --url https://mysite.com/bento/ --out ../my-landing/bento
  • --url is the final address of the site, and it can be a subfolder. Links, images and search then work inside it.
  • --out copies the finished site into another folder, replacing what Blup had put there before. To be safe, Blup never deletes a folder it didn’t fill itself.
  • Then publish the landing page’s folder, for example with a service connected to a GitHub repository: each git push updates the site.

In Portuguese too

blup gerar --url … --saida … does the same.

What only the Studio does

Some things have no command: note vaults, translation, narration, the podcast, the Feedback board, submenus, and publishing and syncing with Blup Cloud. A site that already uses these features keeps building and publishing normally from the terminal. See Studio and command line.