Back to the catalog

Files

Bundle OKF 0.2 · 5 conceitos · acg-box/vibe-mono

Open source Repository Open in the app JSON README (API)

About

# Files

- [Architecture And Runtime](architecture-and-runtime.md) - Explains workspace ownership, runtime and tool boundaries, CLI behavior, and generated state.
- [Knowledge Maintenance](knowledge-maintenance.md)
- [Operations And Validation](operations.md) - Defines local validation, build, release, dependency, and failure-handling operations.
- [Repository Quickstart](quickstart.md) - Routes contributors through repository ownership, prerequisites, common commands, and deeper OpenWiki pages.
- [Template Adoption](template-adoption.md)

Details

Kind
OKF bundles
Topic
Developer tools
Publisher
acg-box
Origin
okf_github
Category
dados
Version
0.2
Stars
6
Open pull requests
3
Last push
2026-09-01T00:07:44Z
Repository state
ativo
Language
TypeScript
License
GPL-3.0
Added
2026-09-08 09:01:12
Updated
2026-09-08 09:01:12
Origin id
acg-box/vibe-mono:openwiki/index.md

README

<div align="center">

# name_placeholder

description_placeholder

[![License](https://img.shields.io/badge/License-GPLv3%20only-blue.svg)](https://spdx.org/licenses/GPL-3.0-only.html)
[![Docs](https://img.shields.io/docsrs/name_placeholder)](https://docs.rs/name_placeholder)
[![Release](https://github.com/hack-ink/name_placeholder/actions/workflows/release.yml/badge.svg)](https://github.com/hack-ink/name_placeholder/actions/workflows/release.yml)
[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/hack-ink/name_placeholder)](https://github.com/hack-ink/name_placeholder/tags)
[![GitHub last commit](https://img.shields.io/github/last-commit/hack-ink/name_placeholder?color=red&style=plastic)](https://github.com/hack-ink/name_placeholder)

</div>

## Feature Highlights

### TODO

TODO

## Status

TODO

## Workspace Posture

- `apps/name_placeholder/` owns the default Rust CLI application package.
- `scripts/` owns repository-maintenance TypeScript programs that run directly on
  the pinned Node.js runtime.
- `packages/` is reserved for reusable shared packages across Rust,
  JavaScript/TypeScript, Python, Swift, or other language toolchains.
- The root `Cargo.toml` is a Rust workspace manifest and owns shared metadata,
  profiles, and dependency versions.
- The root `package.json`, `package-lock.json`, and `tsconfig.json` own the
  TypeScript script toolchain and its exact development dependencies.
- `openwiki/` is the authoritative repository knowledge and agent-routing surface.

## Usage

### Installation

#### Build from Source

```sh
# Clone the repository.
git clone https://github.com/hack-ink/name_placeholder
cd name_placeholder

# To install rustup on macOS and Unix without selecting a global default
# toolchain, run the following command. This repository's rust-toolchain.toml
# selects stable with the minimal profile for ordinary Rust commands.
#
# On Windows, download rustup-init.exe from `https://rustup.rs` and run it with
# `--default-toolchain none`; rust-toolchain.toml still selects stable minimal.
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-toolchain none

# Install the necessary dependencies. (Unix only)
# Using Ubuntu as an example, this really depends on your distribution.
sudo apt-get update
sudo apt-get install <DEPENDENCIES>

# Build the default Rust app, and the binary will be available at `target/release/name_placeholder`.
cargo build --release -p name_placeholder --locked

# Install the default Rust app from the workspace.
cargo install --path apps/name_placeholder --locked --force

# If you are a macOS user and want to have a `name_placeholder.app`, run the following command.
# Install `cargo-bundle` to pack the binary into an app.
cargo install cargo-bundle
# Pack the app, and the it will be available at `target/release/bundle/osx/name_placeholder.app`.
cd apps/name_placeholder
cargo bundle --release
```

#### Download Pre-built Binary

- **macOS**
    - Download the latest pre-built binary from [GitHub Releases](https://github.com/hack-ink/name_placeholder/releases/latest).
- **Windows**
    - TODO
- **Unix**
    - TODO

### Configuration

#### TODO

TODO

### Interaction

TODO

### Update

TODO

## Development

`rust-toolchain.toml` selects the stable toolchain with the minimal profile and
installs Clippy for the repository lint gate. Rust formatting remains a separate
nightly rustfmt invocation through `rustup run nightly`.

Install the exact TypeScript development graph without running package lifecycle
scripts:

```sh
npm ci --ignore-scripts
```

List tracked template markers before adopting the template:

```sh
cargo make list-template-markers
```

Correct repository formatting when needed:

```sh
cargo make fmt
```

Run the repository source-validation gate:

```sh
cargo make check
```

`typecheck` runs TypeScript's `tsc --noEmit`. `lint` runs Clippy for Rust
static analysis, Oxlint, and vstyle. `test` runs Rust tests with nextest and
the TypeScript integration tests. `check` combines these three validation
groups; formatting remains independent and is corrected with `cargo make fmt`.

### Architecture

This template starts as a workspace-first monorepo:

- runnable products belong under `apps/`
- repository-maintenance programs belong under `scripts/`
- reusable packages belong under `packages/`
- repository-native checks are exposed through `Makefile.toml`
- durable architecture, runbook, and routing notes belong under `openwiki/`

## Support Me

If you find this project helpful and would like to support its development, you can buy me a coffee!

Your support is greatly appreciated and motivates me to keep improving this project.

- **Fiat**
    - [Ko-fi](https://ko-fi.com/hack_ink)
    - [Afdian](https://afdian.com/a/hack_ink)
- **Crypto**
    - **Bitcoin**
        - `bc1pedlrf67ss52md29qqkzr2avma6ghyrt4jx9ecp9457qsl75x247sqcp43c`
    - **Ethereum**
        - `0x3e25247CfF03F99a7D83b28F207112234feE73a6`
    - **Polkadot**
        - `156HGo9setPcU2qhFMVWLkcmtCEGySLwNqa3DaEiYSWtte4Y`

Thank you for your support!

## Appreciation

We would like to extend our heartfelt gratitude to the following projects and contributors:

- The Rust community for their continuous support and development of the Rust ecosystem.

## Additional Acknowledgements

- TODO

---

<div align="right">

### License

<sup>Licensed under [GPL-3.0-only](LICENSE).</sup>

</div>

More