Skip to content

Feat/plain forge to installer #242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kaja-s merged 3 commits into from
Jul 7, 2026
Merged

Feat/plain forge to installer #242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
140d047
Add plain-forge and plyn install steps, polish onboarding UI
kaja-s Jul 6, 2026
ee5e121
Add hello-world instructions to examples
kaja-s Jul 6, 2026
704c5be
Updated spelling mistakes
kaja-s Jul 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 23 additions & 12 deletions install/bash/examples.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ set -euo pipefail
# Brand Colors (use exported colors if available, otherwise define them)
YELLOW="${YELLOW:-\033[38;2;224;255;110m}"
GREEN="${GREEN:-\033[38;2;121;252;150m}"
WHITE="${WHITE:-\033[38;2;255;255;255m}"
RED="${RED:-\033[38;2;239;68;68m}"
GRAY="${GRAY:-\033[38;2;128;128;128m}"
BOLD="${BOLD:-\033[1m}"
Expand All @@ -16,9 +17,9 @@ EXAMPLES_DOWNLOAD_URL="https://github.com/Codeplain-ai/plainlang-examples/archiv

# Show current directory and ask for extraction path
CURRENT_DIR=$(pwd)
echo -e " current folder: ${YELLOW}${CURRENT_DIR}${NC}"
echo -e " Current folder: ${WHITE}${CURRENT_DIR}${NC}"
echo ""
echo -e " extract examples here, or enter a different path:"
echo -e " Extract examples here, or enter a different path:"
echo ""
read -r -p " [Enter for current, or type path]: " EXTRACT_PATH < /dev/tty
echo ""
Expand All @@ -35,24 +36,24 @@ SKIP_DOWNLOAD=false

# Check if directory exists, create if not
if [ ! -d "$EXTRACT_PATH" ]; then
echo -e " ${GRAY}creating directory...${NC}"
echo -e " ${GRAY}Creating directory...${NC}"
mkdir -p "$EXTRACT_PATH" 2>/dev/null
if [ $? -ne 0 ]; then
echo -e " ${RED}✗${NC} failed to create directory: ${EXTRACT_PATH}"
echo -e " ${GRAY}skipping example download.${NC}"
echo -e " ${RED}✗ Failed to create directory: ${EXTRACT_PATH}${NC}"
echo -e " ${GRAY}Skipping example download.${NC}"
SKIP_DOWNLOAD=true
fi
fi

if [ "$SKIP_DOWNLOAD" = false ]; then
echo -e " ${GRAY}downloading examples...${NC}"
echo -e " ${GRAY}Downloading examples...${NC}"

# Download the zip file
TEMP_ZIP=$(mktemp)
curl -L -s -o "$TEMP_ZIP" "$EXAMPLES_DOWNLOAD_URL"

if [ $? -eq 0 ] && [ -s "$TEMP_ZIP" ]; then
echo -e " ${GRAY}extracting to ${EXTRACT_PATH}...${NC}"
echo -e " ${GRAY}Extracting to ${EXTRACT_PATH}...${NC}"

# Extract the zip file
unzip -q -o "$TEMP_ZIP" -d "$EXTRACT_PATH" 2>/dev/null
Expand All @@ -71,22 +72,32 @@ if [ "$SKIP_DOWNLOAD" = false ]; then
rm -f "${EXTRACTED_DIR}/.gitignore"
fi

clear
echo ""
echo -e " ${GREEN}✓${NC} examples downloaded successfully!"
echo -e " ${GREEN}✓ Examples downloaded successfully!${NC}"
echo ""
echo -e " examples are in: ${YELLOW}${EXTRACTED_DIR}${NC}"
echo -e " ${GRAY}Examples are in: ${EXTRACTED_DIR}${NC}"
echo ""
echo -e " ${WHITE}${BOLD}Try the hello, world example:${NC}"
echo ""
echo -e " ${GRAY}Example folder:${NC} ${WHITE}cd ${EXTRACTED_DIR}/hello-world/python${NC}"
echo ""
echo -e " ${GRAY}Render the example:${NC} ${WHITE}codeplain hello-world-python.plain${NC}"
echo ""
echo -e " ${GRAY}See hello-world/python/README.md for details.${NC}"
echo ""
else
echo -e " ${RED}✗${NC} failed to extract examples."
echo -e " ${RED}✗ Failed to extract examples.${NC}"
fi

# Clean up temp file
rm -f "$TEMP_ZIP"
else
echo -e " ${RED}✗${NC} failed to download examples."
echo -e " ${RED}✗ Failed to download examples.${NC}"
rm -f "$TEMP_ZIP"
fi

echo ""
read -r -p " press [Enter] to continue..." < /dev/tty
PROMPT=$(printf '%b' " Press ${WHITE}[Enter]${NC} to continue...")
read -r -p "$PROMPT" < /dev/tty
fi
154 changes: 117 additions & 37 deletions install/bash/install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ export YELLOW GREEN GREEN_LIGHT GREEN_DARK BLUE BLACK WHITE RED GRAY GRAY_LIGHT
NONINTERACTIVE="${CODEPLAIN_INSTALL_NONINTERACTIVE:-0}"

if [ "$NONINTERACTIVE" = "1" ]; then
echo "running in non-interactive mode (CODEPLAIN_INSTALL_NONINTERACTIVE=1)"
echo "Running in non-interactive mode (CODEPLAIN_INSTALL_NONINTERACTIVE=1)"
else
clear
fi
echo -e "started ${YELLOW}${BOLD}*codeplain CLI${NC} installation..."
echo -e "Started ${YELLOW}${BOLD}*codeplain CLI${NC} installation..."

# Install uv if not present
install_uv() {
echo -e "installing uv package manager..."
echo -e "Installing uv package manager..."
curl -LsSf https://astral.sh/uv/install.sh | sh
# Add uv to PATH for this session
export PATH="$HOME/.local/bin:$PATH"
Expand All @@ -54,7 +54,7 @@ echo -e ""
if uv tool list 2>/dev/null | grep -q "^codeplain"; then
CURRENT_VERSION=$(uv tool list 2>/dev/null | grep "^codeplain" | sed 's/codeplain v//')
echo -e "${GRAY}codeplain ${CURRENT_VERSION} is already installed.${NC}"
echo -e "upgrading to latest version..."
echo -e "Upgrading to latest version..."
echo -e ""
uv tool upgrade codeplain &> /dev/null
NEW_VERSION=$(uv tool list 2>/dev/null | grep "^codeplain" | sed 's/codeplain v//')
Expand All @@ -64,7 +64,7 @@ if uv tool list 2>/dev/null | grep -q "^codeplain"; then
echo -e "${GREEN}✓${NC} codeplain upgraded from ${CURRENT_VERSION} to ${NEW_VERSION}!"
fi
else
echo -e "installing codeplain...${NC}"
echo -e "Installing codeplain...${NC}"
echo -e ""
uv tool install codeplain
if [ "$NONINTERACTIVE" != "1" ]; then
Expand All @@ -77,38 +77,38 @@ fi
SKIP_API_KEY_SETUP=false
if [ -n "${CODEPLAIN_API_KEY:-}" ]; then
if [ "$NONINTERACTIVE" = "1" ]; then
echo -e "${GREEN}✓${NC} using existing CODEPLAIN_API_KEY (non-interactive mode)."
echo -e "${GREEN}✓${NC} Using existing CODEPLAIN_API_KEY (non-interactive mode)."
SKIP_API_KEY_SETUP=true
else
echo -e " you already have an API key configured."
echo -e " You already have an API key configured."
echo ""
echo -e " would you like to log in and get a new one?"
echo -e "${YELLOW}?${NC} ${WHITE}${BOLD}Would you like to log in and get a new one?${NC}"
echo ""
read -r -p " [y/N]: " GET_NEW_KEY < /dev/tty
read -r -p " [y/N]: " GET_NEW_KEY < /dev/tty
echo ""

if [[ ! "$GET_NEW_KEY" =~ ^[Yy]$ ]]; then
echo -e "${GREEN}✓${NC} using existing API key."
echo -e "${GREEN}✓${NC} Using existing API key."
SKIP_API_KEY_SETUP=true
fi
fi
fi

if [ "$SKIP_API_KEY_SETUP" = false ]; then
if [ "$NONINTERACTIVE" = "1" ]; then
echo -e "${GRAY}no CODEPLAIN_API_KEY set; skipping key setup (non-interactive mode).${NC}"
echo -e "${GRAY}No CODEPLAIN_API_KEY set; skipping key setup (non-interactive mode).${NC}"
else
echo -e "go to ${YELLOW}https://platform.codeplain.ai${NC} and sign up to get your API key."
echo -e "Go to ${YELLOW}https://platform.codeplain.ai${NC} and sign up to get your API key."
echo ""
read -r -p "paste your API key here: " API_KEY < /dev/tty
read -r -p "Paste your API key here: " API_KEY < /dev/tty
echo ""
fi
fi

if [ "$SKIP_API_KEY_SETUP" = true ]; then
: # API key already set, nothing to do
elif [ -z "${API_KEY:-}" ]; then
echo -e "${GRAY}no API key provided. you can set it later with:${NC}"
echo -e "${GRAY}No API key provided. You can set it later with:${NC}"
echo -e " export CODEPLAIN_API_KEY=\"your_api_key\""
else
# Export for current session
Expand Down Expand Up @@ -150,10 +150,6 @@ fi
if [ "$NONINTERACTIVE" != "1" ]; then
clear
fi
echo ""
echo -e "${NC}"
echo -e "${GRAY}────────────────────────────────────────────${NC}"
echo -e ""
cat << 'EOF'
_ _ _
___ ___ __| | ___ _ __ | | __ _(_)_ __
Expand All @@ -163,19 +159,16 @@ cat << 'EOF'
|_|
EOF
echo ""
echo -e "${GREEN}✓${NC} Sign in successful."
echo ""
echo -e " ${YELLOW}welcome to *codeplain!${NC}"
echo -e "${GREEN}✓ Sign in successful.${NC}"
echo ""
echo -e " spec-driven, production-ready code generation"
echo -e " ${WHITE}Welcome to *codeplain!${NC}"
echo ""
echo ""
echo -e "${GRAY}────────────────────────────────────────────${NC}"
echo -e " ${GRAY}Spec-driven, production-ready code generation${NC}"
echo ""
if [ "$NONINTERACTIVE" = "1" ]; then
WALKTHROUGH_CHOICE="n"
else
echo -e " would you like to get a quick intro to ***plain specification language?"
echo -e "${YELLOW}?${NC} ${WHITE}${BOLD}Would you like to get a quick intro to ***plain specification language?${NC}"
echo ""
read -r -p " [Y/n]: " WALKTHROUGH_CHOICE < /dev/tty
echo ""
Expand Down Expand Up @@ -215,20 +208,95 @@ if [[ ! "$WALKTHROUGH_CHOICE" =~ ^[Nn]$ ]]; then
run_script "walkthrough.sh"
fi

# Install plain-forge step
if [ "$NONINTERACTIVE" = "1" ]; then
INSTALL_PLAIN_FORGE="n"
else
clear
echo ""
echo -e " ${YELLOW}${BOLD}plain-forge${NC}"
echo ""
echo -e " plain-forge plugs into your AI coding agent (Claude Code, Codex,"
echo -e " ForgeCode, OpenCode, ...) and turns a conversation into a"
echo -e " complete ***plain spec, keeping it maintained as you grow it."
echo ""
echo -e " ${GRAY}Read more: https://github.com/Codeplain-ai/plain-forge${NC}"
echo ""
echo -e " ${YELLOW}?${NC} ${WHITE}${BOLD}Would you like to install it now?${NC}"
echo ""
read -r -p " [Y/n]: " INSTALL_PLAIN_FORGE < /dev/tty
echo ""
fi

PLAIN_FORGE_INSTALLED=false
if [[ ! "${INSTALL_PLAIN_FORGE:-}" =~ ^[Nn]$ ]]; then
if command -v npx &> /dev/null; then
npx plain-forge install < /dev/tty
PLAIN_FORGE_INSTALLED=true
echo ""
else
echo -e "${GRAY}npx not found. Install Node.js, then run:${NC}"
echo -e " npx plain-forge install"
echo ""
fi
fi

# Install plyn editor extension step
EDITOR_CMDS=()
command -v cursor &> /dev/null && EDITOR_CMDS+=("cursor:Cursor")
command -v code &> /dev/null && EDITOR_CMDS+=("code:VS Code")

if [ "$NONINTERACTIVE" = "1" ]; then
INSTALL_PLYN="n"
else
clear
echo ""
echo -e "${GRAY}────────────────────────────────────────────${NC}"
echo -e " ${YELLOW}${BOLD}plyn Editor Extension${NC}"
echo -e "${GRAY}────────────────────────────────────────────${NC}"
echo ""
echo -e " plyn adds ***plain syntax highlighting to VS Code and Cursor."
echo ""
if [ "${#EDITOR_CMDS[@]}" -gt 0 ]; then
EDITOR_NAMES=$(printf '%s, ' "${EDITOR_CMDS[@]#*:}")
echo -e " Detected ${EDITOR_NAMES%, }."
echo ""
echo -e " ${YELLOW}?${NC} ${WHITE}${BOLD}Install the extension now?${NC}"
echo ""
read -r -p " [Y/n]: " INSTALL_PLYN < /dev/tty
echo ""
else
echo -e " Install it manually from:"
echo -e " ${YELLOW}https://marketplace.visualstudio.com/items?itemName=Codeplain.plyn${NC}"
echo ""
INSTALL_PLYN="n"
fi
fi

PLYN_INSTALLED=false
if [ "${#EDITOR_CMDS[@]}" -gt 0 ] && [[ ! "${INSTALL_PLYN:-}" =~ ^[Nn]$ ]]; then
for entry in "${EDITOR_CMDS[@]}"; do
editor_cmd="${entry%%:*}"
editor_name="${entry#*:}"
"$editor_cmd" --install-extension Codeplain.plyn
echo -e "${GREEN}✓${NC} plyn installed for ${editor_name}"
done
PLYN_INSTALLED=true
echo ""
fi

# Download examples step
if [ "$NONINTERACTIVE" = "1" ]; then
DOWNLOAD_EXAMPLES="n"
else
clear
echo ""
echo -e "${GRAY}────────────────────────────────────────────${NC}"
echo -e " ${YELLOW}${BOLD}Example Projects${NC}"
echo -e "${GRAY}────────────────────────────────────────────${NC}"
echo ""
echo -e " we've prepared some example Plain projects for you"
echo -e " We've prepared some example ***plain projects for you"
echo -e " to explore and experiment with."
echo ""
echo -e " would you like to download them?"
echo -e " ${YELLOW}?${NC} ${WHITE}${BOLD}Would you like to download them?${NC}"
echo ""
read -r -p " [Y/n]: " DOWNLOAD_EXAMPLES < /dev/tty
echo ""
Expand All @@ -244,19 +312,31 @@ if [ "$NONINTERACTIVE" != "1" ]; then
clear
fi
echo ""
echo -e "${GRAY}────────────────────────────────────────────${NC}"
echo -e " ${YELLOW}${BOLD}You're all set!${NC}"
echo -e "${GRAY}────────────────────────────────────────────${NC}"
echo -e " ${WHITE}${BOLD}You're all set!${NC}"
echo ""
echo -e " thank you for using ${YELLOW}*codeplain!${NC}"
echo -e " ${GRAY}Thank you for using *codeplain!${NC}"
echo ""
echo -e " ${BOLD}next steps:${NC}"
echo -e " ${WHITE}${BOLD}Next steps:${NC}"
echo ""
echo -e " join our Discord community: ${YELLOW}https://discord.gg/cgbynb9hFq${NC}"
STEP_NUM=1
if [ "$PLAIN_FORGE_INSTALLED" = false ]; then
echo -e " ${GRAY}${STEP_NUM}.${NC} ${GRAY}Let your agent work in specs, not code:${NC}"
echo -e " ${WHITE}${BOLD}npx plain-forge install${NC}"
echo ""
STEP_NUM=$((STEP_NUM + 1))
fi
if [ "$PLYN_INSTALLED" = false ]; then
echo -e " ${GRAY}${STEP_NUM}.${NC} ${GRAY}Get ***plain syntax highlighting in VS Code / Cursor:${NC}"
echo -e " ${WHITE}${BOLD}https://marketplace.visualstudio.com/items?itemName=Codeplain.plyn${NC}"
echo ""
STEP_NUM=$((STEP_NUM + 1))
fi
echo -e " ${GRAY}${STEP_NUM}.${NC} ${GRAY}Convert your spec into tested and validated code:${NC}"
echo -e " ${WHITE}${BOLD}codeplain your-project.plain${NC}"
echo ""
echo -e " learn more about ${YELLOW}***plain${NC} at ${YELLOW}https://plainlang.org/${NC}"
echo -e " ${GRAY}Discord: https://discord.gg/cgbynb9hFq Docs: https://plainlang.org/${NC}"
echo ""
echo -e " ${GREEN}happy development!${NC} 🚀"
echo -e " ${GRAY}Happy development!${NC} 🚀"
echo ""

if [ "$NONINTERACTIVE" != "1" ]; then
Expand Down
Loading
Loading