ReinschriftTodo

(★ 18)

Plain-text Markdown todo app — native GNOME desktop (GTK4/libadwaita), CLI, and web UI with WebDAV/Nextcloud sync

File Explorer

  • .gitignore
  • build_flatpak.sh
  • Cargo.lock
  • Cargo.toml
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
  • flathub_publish.sh
  • generated-sources.json
  • LICENSE
  • me.dumke.Reinschrift.desktop
  • me.dumke.Reinschrift.metainfo.xml
  • me.dumke.Reinschrift.yml
  • README.de.md
  • README.md
  • reinschrift.doap
  • VERSION

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

cargo build

View Details ▼

Compile a local package and all of its dependencies.

cargo {{[b|build]}}

Build the package or packages defined by the `Cargo.toml` manifest file in the local path:

cargo {{[b|build]}} {{[-r|--release]}}

Build artifacts in release mode, with optimizations:

cargo {{[b|build]}} --locked

Require that `Cargo.lock` is up to date:

🔍

cargo check

View Details ▼

Check a local package and all of its dependencies for errors.

cargo {{[c|check]}}

Check the current package:

cargo {{[c|check]}} --tests

Check all tests:

cargo {{[c|check]}} --test {{integration_test1}}

Check the integration tests in `tests/integration_test1.rs`:

🔍

cargo run

View Details ▼

Run the current Cargo package.
Note: The working directory of the executed binary will be set to the current working directory.

cargo {{[r|run]}}

Run the default binary target:

cargo {{[r|run]}} --bin {{name}}

Run the specified binary:

cargo {{[r|run]}} --example {{name}}

Run the specified example:

🔍

cargo test

View Details ▼

Execute the unit and integration tests of a Rust package.

cargo {{[t|test]}} {{test_name}}

Only run tests containing a specific string in their names:

cargo {{[t|test]}} -- --test-threads {{count}}

Set the number of simultaneous running test cases:

cargo {{[t|test]}} {{[-r|--release]}}

Test artifacts in release mode, with optimizations:

🔍

clang

View Details ▼

Compile C, C++, and Objective-C source files. Can be used as a drop-in replacement for GCC.
Part of LLVM.

clang {{path/to/source1.c path/to/source2.c ...}} {{[-o|--output]}} {{path/to/output_executable}}

Compile multiple source files into an executable:

clang {{path/to/source.c}} -Wall {{[-o|--output]}} {{output_executable}}

Activate output of all errors and warnings:

clang {{path/to/source.c}} -Wall {{[-g|--debug]}} -Og {{[-o|--output]}} {{path/to/output_executable}}

Show common warnings, debug symbols in output, and optimize without affecting debugging:

🔍

cmake

View Details ▼

Cross-platform build automation system, that generates recipes for native build systems.

cmake {{path/to/project_directory}}

Generate a build recipe in the current directory with `CMakeLists.txt` from a project directory:

cmake --build {{path/to/build_directory}}

Use a generated recipe in a given directory to build artifacts:

cmake --install {{path/to/build_directory}} --strip

Install the build artifacts into `/usr/local/` and strip debugging symbols:

🔍

docker compose up

View Details ▼

Start and run Docker services defined in a Compose file.

docker compose up

Start all services defined in the docker-compose file:

docker compose up {{[-d|--detach]}}

Start services in the background (detached mode):

docker compose up --build

Start services and rebuild images before starting:

🔍

done

View Details ▼

This shell keyword is used with `for`, `while`, `select`, and `until` to mark the end of a loop.

tldr for

View documentation for the `for` keyword:

tldr while

View documentation for the `while` keyword:

tldr select

View documentation for the `select` keyword:

🔍

edit

View Details ▼

A terminal-based text editor from Microsoft.

edit {{path/to/file}}

Open a file:

tldr run-mailcap

View documentation for the original command:

<Ctrl f>{{pattern}}<Enter>

Search for a pattern:

🔍

git config

View Details ▼

Manage custom configuration options for Git repositories.
These configurations can be local (for the current repository) or global (for the current user).

git config --global {{user.name|user.email}} "{{Your Name|[email protected]}}"

Globally set your name or email (this information is required to commit to a repository and will be included in all commits):

git config --{{local|global|system}} {{[-l|--list]}} --show-origin

List local, global, or system configuration entries and show their file location:

git config --global {{alias.unstage}} "reset HEAD --"

Set the global value of a given configuration entry (in this case an alias):

🔍

mypy

View Details ▼

Type check Python code.

mypy {{path/to/file.py}}

Type check a specific file:

mypy {{[-m|--module]}} {{module_name}}

Type check a specific module:

mypy {{[-p|--package]}} {{package_name}}

Type check a specific package:

🔍

pip install

View Details ▼

Install Python packages.

pip install {{package1 package2 ...}}

Install one or more packages:

pip install {{package1 package2 ...}} {{[-U|--upgrade]}}

Upgrade all specified packages to the latest version, installing any that are not already present:

pip install {{package}}=={{version}}

Install a specific version of a package:

🔍

pytest

View Details ▼

Run Python tests.

pytest {{path/to/test_file1.py path/to/test_file2.py ...}}

Run tests from specific files:

pytest -k {{expression}}

Run tests with names matching a specific [k]eyword expression:

pytest {{[-x|--exitfirst]}}

Exit as soon as a test fails or encounters an error:

🔍

flatpak

View Details ▼

Build, install, and run flatpak applications and runtimes.

flatpak run {{com.example.app}}

Run an installed application:

flatpak install {{remote_name}} {{com.example.app}}

Install an application from a remote source:

flatpak list --app

List installed applications, ignoring runtimes:

// repository documentation