Download the source

§6.1 Download the source

The CLI is an optional command-line tool for people who prefer their own editor or use an AI coding assistant. You can do all the writing described in the earlier chapters through the website.

With Python 3.12 or newer and pipx installed, install the released client.

pipx install peerpedia-cli
peerpedia --version

To download this demo, replace PAPER_ID below with its paper ID. You can find that ID in the paper’s details-page address, immediately after /papers/. Choose a new destination folder.

peerpedia clone PAPER_ID ./peerpedia-demo --server https://peerpedia.dev

The downloaded folder contains the chapter files, paper.json, the shared bibliography, and the CLI’s tracking data. You can read it without signing in.

§Start a separate note from the examples

Cloning keeps a connection to this demo. Pushing edits from that copy proposes a PR to this paper. To publish your own independent note, start a new folder instead.

peerpedia init ./my-note --server https://peerpedia.dev

Copy the examples you want into the new note. Set your own metadata in paper.json. For a note with two chapters, the chapter-related fields look like this.

{
  "chapters": [
    {"id": "introduction", "title": "Introduction", "file": "chapters/introduction.md"},
    {"id": "examples", "title": "Examples", "file": "chapters/examples.md"}
  ],
  "bibliography": "references.yaml"
}

These are part of the metadata, not a replacement for the title, author list, abstract, subjects, and license. Keep chapter IDs stable if you rename or reorder chapters. Do not copy the demo’s hidden .peerpedia tracking folder into your new note.

Read the CLI guide for account connection and submission. A push from a new note publishes immediately. A push from a clone proposes a revision. Review the local differences before either action, and include --ai-assisted if AI helped prepare the submission.

Return to Section 1.1 to use the browser-only path.

§References

License · CC0 1.0 · Peerpedia collaboration terms