scaffold: M0 skeleton + agent onboarding (build, architecture, progress)

Turn the design into a buildable, dependency-free M0 skeleton plus the
onboarding layer so a new agent can pick up instantly.

Build system:
- CMake + CMakePresets (dev = no deps; server-release = vcpkg) + vcpkg.json
- Skeleton builds with just a C++20 compiler; deps stay off until needed
- .gitattributes (LF), .gitignore, .clang-format

Core (libvoicecat):
- core/include/voicecat.h: full C ABI (the client/server contract), stubbed
- core/proto/voicecat.proto: control-plane wire format, matches docs/protocol.md
- src/{net,crypto,codec,protocol,session,audio,core}: subsystem stubs that
  return VC_ERR_NOT_IMPLEMENTED, each pointing to its design doc
- server/ (voicecat-server) and tools/vccli/ link the core
- tests/: CTest smoke test asserting the C ABI contract (behavior, not just build)
- clients/{apple,windows}: M4 placeholders

Onboarding for agents:
- CLAUDE.md: hub — build/test commands, architecture at a glance, doc map, rules
- AGENTS.md: working method (behavior-driven; clean compile is the floor not the goal)
- PROGRESS.md: living tracker — M0 done, M1 task checklist, "where we left off"

Verified: cmake --preset dev && cmake --build --preset dev && ctest --preset dev → green.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
2026-06-15 21:09:09 +02:00
parent 268d511f79
commit b332b0972b
38 changed files with 1907 additions and 0 deletions

68
server/src/main.cpp Normal file
View File

@@ -0,0 +1,68 @@
/*
* voicecat-server entry point (M0 skeleton).
*
* Goal (docs/deployment.md): one command, zero config, encrypted + listening. Today it
* parses a few flags and prints what it would do.
*/
#include <cstdio>
#include <cstring>
#include <string>
#include "server.h"
#include "voicecat.h"
namespace {
void print_help(const char* argv0) {
std::printf(
"voicecat-server %s\n\n"
"Usage: %s [options]\n"
" --port <n> control+media port (default 8384)\n"
" --data-dir <path> data directory (default ./voicecat-data)\n"
" --name <name> server name\n"
" --no-guests disable guest access\n"
" --print-config print effective config and exit\n"
" --version print version and exit\n"
" --help this help\n",
vc_version_string(), argv0);
}
} // namespace
int main(int argc, char** argv) {
voicecat::server::Config cfg;
bool print_config_only = false;
for (int i = 1; i < argc; ++i) {
const char* a = argv[i];
auto next = [&]() -> const char* { return (i + 1 < argc) ? argv[++i] : ""; };
if (std::strcmp(a, "--help") == 0) {
print_help(argv[0]);
return 0;
} else if (std::strcmp(a, "--version") == 0) {
std::printf("voicecat-server %s (protocol v%d)\n", vc_version_string(),
VOICECAT_PROTOCOL_VERSION);
return 0;
} else if (std::strcmp(a, "--port") == 0) {
cfg.bind_port = static_cast<uint16_t>(std::atoi(next()));
} else if (std::strcmp(a, "--data-dir") == 0) {
cfg.data_dir = next();
} else if (std::strcmp(a, "--name") == 0) {
cfg.server_name = next();
} else if (std::strcmp(a, "--no-guests") == 0) {
cfg.allow_guests = false;
} else if (std::strcmp(a, "--print-config") == 0) {
print_config_only = true;
} else {
std::fprintf(stderr, "unknown option: %s (try --help)\n", a);
return 2;
}
}
std::printf("[voicecat-server %s] starting\n", vc_version_string());
voicecat::server::Server server(cfg);
if (print_config_only) {
// run() currently just prints config; in M1 split this into a pure config dump.
}
return server.run();
}

20
server/src/server.cpp Normal file
View File

@@ -0,0 +1,20 @@
#include "server.h"
#include <cstdio>
namespace voicecat::server {
int Server::run() {
// M0 stub: report what a real run WILL do, then exit. M1 brings up the TLS listener,
// session registry, and channel manager (docs/architecture.md §5).
std::printf(" server_name : %s\n", cfg_.server_name.c_str());
std::printf(" data_dir : %s\n", cfg_.data_dir.c_str());
std::printf(" bind_port : %u (TCP control + UDP media)\n", cfg_.bind_port);
std::printf(" allow_guests: %s\n", cfg_.allow_guests ? "true" : "false");
std::printf(" fingerprint : <generated on first run — TODO M1>\n");
std::printf("\n[voicecat-server] M0 skeleton: networking not implemented yet. "
"See docs/roadmap.md (M1) and AGENTS.md.\n");
return 0;
}
} // namespace voicecat::server

40
server/src/server.h Normal file
View File

@@ -0,0 +1,40 @@
/*
* server.h — voicecat-server skeleton.
*
* Design: docs/architecture.md §5, docs/deployment.md. Headless process that links the core.
* Responsibilities: connection manager (TLS), session registry, channel manager, text router,
* voice SFU relay, SQLite persistence. Zero-config: self-provisions Ed25519 identity + cert
* on first run, embedded SQLite, guests on by default.
*
* STATUS: M0 stub — prints config and exits; does not yet listen.
*/
#ifndef VOICECAT_SERVER_SERVER_H
#define VOICECAT_SERVER_SERVER_H
#include <cstdint>
#include <string>
namespace voicecat::server {
struct Config {
std::string server_name = "VoiceCat Server";
std::string data_dir = "voicecat-data";
uint16_t bind_port = 8384; // TCP + UDP (docs/deployment.md §2)
bool allow_guests = true;
};
class Server {
public:
explicit Server(Config cfg) : cfg_(std::move(cfg)) {}
// TODO(M1): bind TLS control listener + UDP media socket; run the Asio loop until stop.
// Returns process exit code.
int run();
private:
Config cfg_;
};
} // namespace voicecat::server
#endif // VOICECAT_SERVER_SERVER_H