Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 119 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
// SPDX-License-Identifier: AGPL-3.0-or-later
= Hyperpolymath Scripts
:toc: macro
:toclevels: 2
:icons: font

Personal scripts and automation tools following the Hyperpolymath Standard.

toc::[]

== Status

[IMPORTANT]
====
**Repo project specification** - scripts will be uploaded shortly.

Infrastructure and policies are in place; script implementations pending.
====

== Planned Scripts

[cols="1,3", options="header"]
|===
|Script |Purpose

|`asdfman.sh`
|Manage asdf plugins and versions

|`init_bashrc_three_ply.sh`
|Modular bashrc setup (three-layer architecture)

|`k-check.sh`
|Kinoite cluster validation

|`k-intune.sh`
|Kinoite tuning scripts

|`langstrap.sh`
|Mass language install utilities

|`sysenv.sh`
|System environment setup

|`touchscreen_hunter_killer.sh`
|Touchscreen calibration/management
|===

== Infrastructure

=== Multi-Forge Mirroring

This repository uses a hub-and-spoke model with GitHub as the hub:

* **GitLab** - `gitlab.com/hyperpolymath/scripts`
* **Codeberg** - `codeberg.org/hyperpolymath/scripts`
* **Bitbucket** - `bitbucket.org/hyperpolymath/scripts`

Features:

* SSH host key verification (MITM protection)
* SHA-pinned action dependencies
* Instant sync on push/release via `.git-private-farm` dispatch

=== Security Hardening

* Ed25519 SSH keys only
* Principle of least privilege (`contents: read`)
* No dynamic host key acceptance

== Language Policy

This repo follows the **Hyperpolymath Standard** (see `.claude/CLAUDE.md`):

[cols="1,2", options="header"]
|===
|Allowed |Use Case

|Bash/POSIX Shell
|Scripts, automation

|Rust
|Performance-critical tools, CLI

|ReScript
|Application code (compiles to JS)

|Deno
|JS runtime (replaces Node)

|Gleam
|Backend services

|Guile Scheme
|State/meta files
|===

[cols="1,1", options="header"]
|===
|Banned |Replacement

|TypeScript |ReScript
|Node.js/npm |Deno
|Go |Rust
|Python (general) |Rust/ReScript
|===

== Usage

[source,bash]
----
# Clone from any forge
git clone git@gitlab.com:hyperpolymath/scripts.git
git clone git@codeberg.org:hyperpolymath/scripts.git
git clone git@github.com:hyperpolymath/scripts.git
----

== License

AGPL-3.0-or-later
62 changes: 62 additions & 0 deletions ROADMAP.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
// SPDX-License-Identifier: AGPL-3.0-or-later
= Roadmap
:icons: font

== Current State

[cols="1,1,3", options="header"]
|===
|Component |Status |Notes

|Multi-forge mirroring
|icon:check-circle[role="green"] Done
|GitHub → GitLab/Codeberg/Bitbucket

|Instant sync dispatch
|icon:check-circle[role="green"] Done
|Triggers `.git-private-farm` propagation

|SSH hardening
|icon:check-circle[role="green"] Done
|Ed25519 host keys, pinned actions

|Language policy
|icon:check-circle[role="green"] Done
|Hyperpolymath Standard defined

|Script implementations
|icon:clock[role="orange"] Pending
|All 7 scripts to be uploaded
|===

== Phase 1: Core Scripts

[%interactive]
* [ ] `sysenv.sh` - System environment bootstrap
* [ ] `langstrap.sh` - Language toolchain installer
* [ ] `asdfman.sh` - asdf version manager helper

== Phase 2: Shell Configuration

[%interactive]
* [ ] `init_bashrc_three_ply.sh` - Modular bashrc
** Layer 1: Core aliases/functions
** Layer 2: Environment-specific
** Layer 3: Machine-local overrides

== Phase 3: Fedora Kinoite Tools

[%interactive]
* [ ] `k-check.sh` - Cluster validation
* [ ] `k-intune.sh` - Tuning automation

== Phase 4: Hardware Utilities

[%interactive]
* [ ] `touchscreen_hunter_killer.sh` - Touchscreen management

== Future Considerations

* Rust rewrites for performance-critical scripts
* Guix/Nix packaging (`guix.scm`, `flake.nix`)
* Integration with broader Hyperpolymath ecosystem