{"id":28475933,"url":"https://github.com/maxtek6/hyperpage","last_synced_at":"2026-03-10T05:03:55.175Z","repository":{"id":296789177,"uuid":"992168465","full_name":"maxtek6/hyperpage","owner":"maxtek6","description":"Fast and efficient solution for storing and loading web content","archived":false,"fork":false,"pushed_at":"2025-10-17T19:01:04.000Z","size":71,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-10-18T21:23:26.980Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maxtek6.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-05-28T18:15:22.000Z","updated_at":"2025-10-17T19:01:05.000Z","dependencies_parsed_at":"2025-06-02T12:08:21.039Z","dependency_job_id":"284d70f3-b5ba-45f0-8c86-410053d6fdc9","html_url":"https://github.com/maxtek6/hyperpage","commit_stats":null,"previous_names":["maxtek6/hyperpage"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/maxtek6/hyperpage","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxtek6%2Fhyperpage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxtek6%2Fhyperpage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxtek6%2Fhyperpage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxtek6%2Fhyperpage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maxtek6","download_url":"https://codeload.github.com/maxtek6/hyperpage/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxtek6%2Fhyperpage/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30325601,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T01:36:58.598Z","status":"online","status_checked_at":"2026-03-10T02:00:06.579Z","response_time":106,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-07T15:05:40.900Z","updated_at":"2026-03-10T05:03:55.117Z","avatar_url":"https://github.com/maxtek6.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hyperpage\n\n![status](https://github.com/maxtek6/hyperpage/actions/workflows/pipeline.yml/badge.svg)\n[![codecov](https://codecov.io/gh/maxtek6/hyperpage/branch/master/graph/badge.svg)](https://codecov.io/gh/maxtek6/hyperpage)\n\nFast, clean, and efficient solution for archiving and retrieving web content.\n\n## Requirements\n\n+ CMake\n+ C++17\n+ NodeJS (only used for example app)\n\n## Usage\n\nThis project provides two components:\n\n+ `hyperpage`: A library with an API for reading and writing archives\n+ `hyperpack`: A command line tool for archiving web content\n\n### `hyperpage`\n\nHyperpage is the C++ API provided by this project. It provides all of \nthe interfaces required to utilize the hyperpage database:\n\n+ `hyperpage::page`: An abstract class representing a single entry in \nthe database. It provides the path, mime type, and content.\n\n+ `hyperpage::reader`: Loads pages from the database. Given a path,\nthe reader will provide a pointer to a page if it exists.\n\n+ `hyperpage::writer`: Stores pages in the database. Given a page, the\nwriter will create a database entry that can later be loaded by path.\n\n### `hyperpack`\n\nHyperpack is a command line utility used to create a hyperpage database \nfile:\n\n```\nUsage: hyperpack [--help] [--version] [--output VAR] [--verbose] directories...\n\nPositional arguments:\n  directories    Directories to scan for files to pack into the hyperpage database [nargs: 1 or more] [required]\n\nOptional arguments:\n  -h, --help     shows help message and exits\n  -v, --version  prints version information and exits\n  -o, --output   Output file for the hyperpage database [nargs=0..1] [default: \"hyperpage.db\"]\n  -v, --verbose  Show detailed output information\n```\n\n### Note on Overwriting\n\nIf two or more files share the same **relative subpath** (i.e., the same path within their respective parent directories), the file from the **rightmost directory** specified on the command line will overwrite the others in the final archive.\n\nOnly **exact path matches** are considered conflicts — differing subdirectories or filenames will coexist as separate entries.\n\n#### Example\n\nSuppose you run:\n```bash\nhyperpack -o output.hp dir1 dir2 dir3\n```\nAnd the directories contain:\n```bash\ndir1/Subdir1/index.html\ndir2/Subdir2/index.html\ndir3/Index.html\n```\nThese will result in three distinct files inside the archive:\n```bash\nSubdir1/index.html\n/Subdir2/index.html\n/Index.html\n```\nHowever, if two or more directories contain the same relative path, for example:\n```bash\ndir1/public/index.html\ndir2/public/index.html\n```\nthen the file from dir2 (the rightmost one) will overwrite the file from dir1 in the resulting archive entry:\n```bash\n/public/index.html\n```\n### Documentation and Example\n\nThis is only intended to cover basic usage. For more info about the API,\nsee the [docs](https://maxtek6.github.io/docs/hyperpage). To see how hyperpage is used in a basic use case, the [example](https://github.com/maxtek6/hyperpage/tree/master/example) should be helpful. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxtek6%2Fhyperpage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaxtek6%2Fhyperpage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxtek6%2Fhyperpage/lists"}