przeprogramowani
2f4ebd3b75
* docs: add corporate network allowlist for security/sysadmin teams Polish sysadmin spec plus a machine-readable host list and a source-scan test so new CLI destinations cannot land undocumented. * chore(release): prepare v1.23.1 * docs: rewrite corporate allowlist in sysadmin language (PL+EN) Plain host/port/protocol tables, matching English document, and an allowlist test that covers both language files. * docs: drop localhost from the corporate network allowlist Public DNS names only; the source scan skips IP literals and single-label hosts so local-dev URLs stay out of the sysadmin spec. --------- Co-authored-by: Claude <noreply@anthropic.com>
4.5 KiB
Platform Support
Requirements
- Node 20+ — the only runtime dependency on all platforms.
- Corporate network allowlist: Polish wymagania-sieciowe.md, English network-requirements.md.
Supported platforms
| Platform | Install methods | Config location | Clipboard |
|---|---|---|---|
| macOS | npx, npm global, binary | ~/.config/10x-cli/ |
pbcopy |
| Linux | npx, npm global, binary | ~/.config/10x-cli/ (or $XDG_CONFIG_HOME/10x-cli/) |
xclip or xsel |
| Windows | npx, npm global, binary (.exe) | %APPDATA%\10x-cli\ |
clip.exe |
Zero-install usage
On any platform, run directly with npx — no global install needed:
npx @przeprogramowani/10x-cli auth
npx @przeprogramowani/10x-cli get m1l1
Shell recommendations
| Platform | Recommended shell |
|---|---|
| macOS | Terminal.app / iTerm2 (zsh) |
| Linux | Any terminal (bash / zsh) |
| Windows | Windows Terminal + PowerShell — renders ANSI colors and Unicode symbols correctly. Legacy cmd.exe may garble output. |
Clipboard
Skills that copy output to the clipboard work automatically on all platforms. Each skill provides both bash and PowerShell clipboard commands so your AI agent can pick the right one for your shell.
| Shell | Clipboard command |
|---|---|
| bash / zsh (macOS) | pbcopy |
| bash / zsh (Linux) | xclip -selection clipboard |
| bash / PowerShell (Windows) | clip.exe |
| PowerShell (native) | Set-Clipboard |
If no clipboard tool is available (e.g., headless Linux server), the copy fails silently — no error is shown.
To install clipboard support on Linux:
# Debian / Ubuntu
sudo apt install xclip
# Fedora
sudo dnf install xclip
AI tool support
The CLI writes artifacts to the correct directory for your AI coding tool:
| Tool | Skills directory | Rules file | Config templates |
|---|---|---|---|
| Claude Code | .claude/skills/ |
CLAUDE.md |
.claude/config-templates/ |
| Cursor | .cursor/skills/ |
.cursor/rules/10x-course.mdc |
.cursor/config-templates/ |
| GitHub Copilot | .github/skills/ |
.github/copilot-instructions.md |
.github/config-templates/ |
| Codex CLI | .agents/skills/ |
AGENTS.md |
.agents/config-templates/ |
| Devin Desktop | .devin/skills/ |
AGENTS.md |
.devin/config-templates/ |
| Kiro | .kiro/skills/ |
AGENTS.md |
.kiro/config-templates/ |
| Generic | .ai/skills/ |
AGENTS.md |
.ai/config-templates/ |
The CLI auto-detects your tool from project markers on first run. Override anytime with --tool:
10x get m1l1 --tool cursor
Kiro reads the root AGENTS.md as steering context, so it writes to the same
file as Codex CLI, Devin Desktop and Generic. Two profiles can hold the same
sentinel block only when their course-rules content is byte-identical — for Kiro
that means Generic. Installing Kiro alongside Codex CLI or Devin Desktop in one
project leaves the first owner's block untouched and reports the rules as
conflict: skipped (incompatible_shared_owner); every other artifact still
installs normally. Pick one of those profiles per project, or accept that only
the first one to run keeps the course rules.
Kiro is detected from .kiro/steering/, .kiro/specs/, .kiro/hooks/,
.kiro/settings/ or a bare .kiro/ directory.
.kiro/prompts/ and .kiro/config-templates/ are staging locations the CLI
manages but Kiro does not read automatically — move any artifact you want Kiro
to pick up to the place Kiro expects it (.kiro/steering/ for always-on
context, .kiro/hooks/ for hooks).
windsurf remains a backward-compatible alias for devin-desktop. New files
use Devin Desktop's .devin/ workspace convention; legacy .windsurf/ markers
are still detected so existing 10x artifacts can be migrated.
CI testing
The CLI is tested on both Ubuntu and Windows in CI:
| Test level | Ubuntu | Windows |
|---|---|---|
| Unit + integration | check job |
check-windows job (PowerShell) |
| Smoke (compiled binary) | check job |
check-windows job |
| End-to-end (CLI ↔ production API) | e2e job |
e2e-windows job |
The e2e jobs build the compiled binary, then spawn it as a subprocess against the real production API. Auth is automated via Resend magic-link email retrieval. E2e jobs run after their respective check jobs pass but do not block the fast feedback loop — a flaky e2e failure won't prevent unit test results from appearing quickly.