Student quick guide

Commands used during the product build

A plain-English reference for the terminal commands used to inspect, test, deploy, and verify the app. Focus on what each tool helps us do, not memorizing every argument.

What this guide covers

These commands supported the full product workflow: understanding the codebase, preparing local configuration, running tests, connecting deployment services, pushing changes, and confirming the live site worked.

No commands match your search yet. Try a shorter word like "git", "test", "database", or "deploy".

App & Service Runtime

Tools used to start, inspect, or stop local services while testing the app.

Initial Command Example Explanation
lsof lsof -nP -iTCP:3000 Checks what is using a network port. Used to see whether the local app was already running.
mongod mongod --dbpath ... --port 27117 Starts a local MongoDB database. Used to test the app safely without touching production data.
nohup nohup mongod --dbpath ... & Starts a long-running process in the background. Used to keep a temporary local database running while tests executed.
pkill pkill -f mongod Stops a running background process. Used to shut down temporary local services after testing.
preview_logs preview_logs Reads logs from the previewed app. Used to confirm startup health and diagnose errors.
preview_start preview_start Starts the app using the preview tool. Used to boot the product locally and confirm it connected properly.

Application Scripting

Small app-specific scripts used to inspect or reset local product data.

Initial Command Example Explanation
node node -e "...DemoUsage.deleteMany({})..." Runs JavaScript directly. Used to perform app-specific maintenance, such as resetting local test data.

Code & File Discovery

Read-only commands used to understand the project before changing anything.

Initial Command Example Explanation
cat cat package.json Opens and displays a file. Used to read app configuration, code, tests, and setup files.
find find routes -type f Searches through folders to locate files. Useful for understanding where product features, settings, tests, or assistant skills live.
grep grep '^PORT=' .env Searches inside files for specific text. Used to find settings such as ports, passwords, or environment variables.
head head server.js Shows the beginning of a file. Used to quickly inspect app startup code without opening the whole file.
ls ls marketing-site Lists what is inside a folder. Used to quickly inspect the project structure.
pwd pwd Shows the current folder. Used to confirm where commands were being run.
sed cat .env | sed 's/=.*/=<redacted>/' Edits text output before showing it. Used here to show config names while hiding secret values.
wc wc -l SKILL.md Counts lines, words, or characters. Used as a quick sanity check on the size of a newly created skill file.
which which vercel Checks whether a tool is installed and where it lives. Used to confirm deployment tooling was available.

Configuration

Commands used to prepare or inspect local settings safely.

Initial Command Example Explanation
cp cp .env.example .env Copies a file. Used to create or reset a local configuration file from a template.
env env | grep vercel Lists current environment settings. Used to check whether deployment-related credentials were already available locally.

Deployment

Commands used to connect the app to hosting and configure production deployment.

Initial Command Example Explanation
vercel npx vercel link --yes Connects the app to Vercel hosting. Used to link the project, check deployment settings, and configure production environment variables.

External Verification

Commands used to confirm that local and live product pages respond correctly.

Initial Command Example Explanation
curl curl localhost:3000/admin/login Calls a web page or API from the command line. Used to verify that local and live product pages responded correctly.

Project Maintenance

Commands used to create folders, install dependencies, or clean temporary files.

Initial Command Example Explanation
mkdir mkdir -p marketing-site/models Creates folders. Used to set up project or skill file structure.
npm npm install Installs the app's dependencies. In product terms, it prepares the project so the software can run.
rm rm -f /tmp/admin_cookie.txt Deletes files. Used to clean up temporary test files after verification.

Testing

Commands used to simulate user behavior and check that important product flows still work.

Initial Command Example Explanation
npx npx playwright test Runs project tools without manually opening them. Used for browser testing, Vercel setup, and other development utilities.
playwright npx playwright test Simulates real user behavior in a browser. Used to verify login, search, admin, and other product flows.

Version Control & CI/CD

Commands used to manage code versions, publish changes, and monitor automated delivery pipelines.

Initial Command Example Explanation
gh gh run watch --exit-status Controls GitHub from the command line. Used to inspect the repository, configure secrets, monitor CI runs, and view failure logs.
git git status Manages versions of the codebase. Used to review changes, commit work, sync with the remote repository, and push updates.