Commands

Commands

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

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

Blup at 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, custom domain, general password and comments
blup syncblup sincronizarKeeps the notes in a private GitHub repository
blup convertblup converterTurns [[wikilinks]] into 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

More than one site

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

No questions

blup build asks nothing: good for scripts and automation. The site goes to the public folder inside the site folder.

A site inside a subfolder

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

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

In Portuguese too

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