Getting started

Sign in once, bind a repo when a team needs you, keep plm itself fresh.

plm needs exactly one thing before it is useful: a signed-in you. Login runs through elvix in the browser (a device flow, no token to paste), and from that moment your personal tools work from any directory: notes, my files, doodles, HTML and markdown files are all keyed to your account, not to a repo. Linking comes second, and only where a team lives: run plm link inside a repo to bind it to its hub project, and the team verbs (commit, push, problems, storage, tasks) know where to report.

1. Step 1 of 5

   One door for everything

   login opens your browser on the hub's device page; you confirm a short code and plm receives its key. Nothing is pasted, nothing is typed twice. Once you are in, every personal verb in this handbook works from wherever your terminal happens to be.

   plm login

   $ plm login

   Sign in to PLMHub:

   https://plmhub.eu/device?code=G9N2-4NW4

   Confirm this code: G9N2-4NW4

   Waiting for approval...

   ✓ logged in as edvard@edvone.dev · https://api.plmhub.eu

2. Step 2 of 5

   Check the handshake

   whoami answers with who you are and which hub you are talking to, and exits 1 when you are not signed in, so scripts and agents can gate on it before doing anything else.

   plm whoami

   $ plm whoami

   ✓ logged in as edvard@edvone.dev · SUPER_ADMIN · https://api.plmhub.eu

   full form · plm whoami · plm status

3. Step 3 of 5

   Bind a repo to its project

   link writes .plmhub/config.json, a committed file, so the whole team shares the binding: from here on, commit, push, problems, storage and tasks all know which project this repo belongs to. Your personal tools never need it.

   plm link plmhub

   $ plm link plmhub

   ✓ linked this repo to PLMHub (.plmhub/config.json)

   full form · plm link <project-slug> [--app <name>] [--db <id>]

4. Step 4 of 5

   The map, in your terminal

   commands prints the same catalog this handbook is generated from: every group, every verb, and the help entry that goes deeper. Name a group to see just that chapter.

   plm commands doodle

   $ plm commands doodle

   plm — command groups

   doodle (alias: ddl)

   Fabric scene editor — full toolbar parity · plm doodle help

   new · use · rename · ls · show · pull · push · add · text · draw · comment

   svg · image · frame · layout · size · nest · wrap · unwrap · move · copy

   set · name · lock · hide · rm · layer · group · ungroup · present · bg

   board · clear · undo · redo · watch

   full form · plm commands [group]

5. Step 5 of 5

   Keep plm fresh

   update knows how it was installed and does the right thing: a source checkout pulls, an npm install reinstalls @latest, a standalone binary points you at the download. One verb, no guessing.

   plm update

   $ plm update

   plm 0.3.0 — source checkout at /home/edvard/projects/plm/

   Already up to date.

   ✓ plm 0.3.0

   full form · plm update · plm upgrade

Also in this chapter

• Credentials live in ~/.plmhub/config.json (0600). PLMHUB_TOKEN and PLMHUB_API environment variables override them for CI.
• Signed in, the personal tools (Notes, My files, Doodles, HTMLs, Markdowns) work from any directory; only the team verbs need plm link.