Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 1.27 KB

File metadata and controls

42 lines (29 loc) · 1.27 KB

Command Reference

This repository is currently maintained in a Windows workspace. Many examples use PowerShell because the active Codex shell for this project is PowerShell.

Agents or contributors using Git Bash, WSL, Linux, or macOS should use the Bash equivalents below.

Basic Inspection

Purpose PowerShell Bash
Show git status git status --short git status --short
List top-level files Get-ChildItem -Force ls -la
List files to depth 3 Get-ChildItem -Recurse -Depth 3 find . -maxdepth 3 -print
Read a file Get-Content -Raw docs\project_plan.md cat docs/project_plan.md
Search text Select-String -Path docs\*.md -Pattern 'SciFigSem' grep -R "SciFigSem" docs

Python and Tests

Use these commands in either shell:

python -m pip install -e .
python -m pytest
python -m pytest tests/test_schemas.py -v

On Windows, python may need to be replaced with py:

py -m pip install -e .
py -m pytest

Path Style

Documentation should prefer forward slashes for repository paths, such as:

src/dsmaf_light/data_generation/schemas.py

PowerShell accepts forward slashes in most Python and git commands, and this style is easier for multi-platform collaboration.