Skip to content

🎨 Palette: 터미널 좜λ ₯ 및 μ—λŸ¬ λ©”μ‹œμ§€ UX/DX κ°œμ„  #333

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
seonghobae merged 1 commit into from
Jul 23, 2026
Merged

🎨 Palette: 터미널 좜λ ₯ 및 μ—λŸ¬ λ©”μ‹œμ§€ UX/DX κ°œμ„  #333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions .jules/palette.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,7 @@
## 2024-08-05 - Dynamic Rendering Cursor Position
**Learning:** When recreating input elements dynamically during client-side rendering (e.g. updating `innerHTML` after a search keystroke), re-focusing the element isn't enough. Simply placing the cursor at the end of the value disrupts users who are editing text in the middle of a string.
**Action:** Always capture `e.target.selectionStart` and `e.target.selectionEnd` before the DOM is replaced, and use `el.setSelectionRange(start, end)` after the element is re-rendered to maintain a seamless typing experience.

## 2026-07-18 - ν‘œμ€€ν™”λœ μ—λŸ¬ λ©”μ‹œμ§€μ™€ 동적 λ³΅μˆ˜ν˜• 처리
**Learning:** CLI λ„κ΅¬μ—μ„œ μ—λŸ¬ λ©”μ‹œμ§€μ˜ 일관성(`❌ Error:`)κ³Ό μ‹€μ²œ κ°€λŠ₯ν•œ μ‘°μ–Έ(`πŸ’‘ Hint:`)의 λͺ…ν™•ν•œ ꡬ뢄은 μ‚¬μš©μžμ˜ 문제 ν•΄κ²° κ²½ν—˜μ„ 크게 ν–₯μƒμ‹œν‚¨λ‹€. λ˜ν•œ ν•˜λ“œμ½”λ”©λœ λ³΅μˆ˜ν˜• 접미사(예: `components`)λŠ” 터미널 좜λ ₯의 ν’ˆμ§ˆμ„ λ–¨μ–΄λœ¨λ¦°λ‹€.
**Action:** ν–₯ν›„ CLI 좜λ ₯ λ©”μ‹œμ§€λ₯Ό μž‘μ„±ν•  λ•Œ, λ°˜λ“œμ‹œ μΌκ΄€λœ 접두어λ₯Ό μ‚¬μš©ν•˜κ³ , μˆ˜λŸ‰μ— λ”°λ₯Έ λ‹¨μˆ˜/볡수 처리λ₯Ό μ‚Όν•­ μ—°μ‚°μž 등을 톡해 λ™μ μœΌλ‘œ μ²˜λ¦¬ν•΄μ•Ό ν•œλ‹€.
173 changes: 113 additions & 60 deletions scanner/cli/appguardrail.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,28 +60,20 @@
from appguardrail_core.config import load_config
from appguardrail_core.external import build_external_scan_plan
from appguardrail_core.findings import NON_BLOCKING_CONTEXTS
from appguardrail_core.findings import is_deploy_blocking as core_is_deploy_blocking
from appguardrail_core.findings import \
is_deploy_blocking as core_is_deploy_blocking
Comment thread
seonghobae marked this conversation as resolved.
from appguardrail_core.findings import normalize_findings
from appguardrail_core.language import (
LANGUAGE_EXTENSIONS,
detect_language_axes,
detect_stack_profile,
)
from appguardrail_core.org_bundle import (
OrgBundleError,
annotate_missing_pr_repositories,
gh_error_message,
gh_pr_list,
gh_repo_list,
)
from appguardrail_core.language import (LANGUAGE_EXTENSIONS,
detect_language_axes,
detect_stack_profile)
from appguardrail_core.org_bundle import (OrgBundleError,
annotate_missing_pr_repositories,
gh_error_message, gh_pr_list,
gh_repo_list)
from appguardrail_core.org_bundle import load_json as load_org_json
from appguardrail_core.org_bundle import render_org_evidence, write_bundle
from appguardrail_core.reports import (
REPORT_TYPE_LABELS,
ReportContext,
render_report,
supported_report_types,
)
from appguardrail_core.reports import (REPORT_TYPE_LABELS, ReportContext,
render_report, supported_report_types)
from appguardrail_core.rules import build_rule_metadata

__version__ = "0.1.1"
Expand All @@ -100,10 +92,7 @@ def _format_msg(msg: str) -> str:
def _console_print(*values, **kwargs) -> None:
"""Print CLI values after applying accessibility formatting to strings."""
_ORIGINAL_PRINT(
*(
_format_msg(value) if isinstance(value, str) else value
for value in values
),
*(_format_msg(value) if isinstance(value, str) else value for value in values),
**kwargs,
)

Expand Down Expand Up @@ -1315,7 +1304,7 @@ def cmd_init(args):

def _print_supabase_reminder():
"""Print extra operational reminders for Supabase-backed projects."""
_console_print("\nπŸ’‘ Supabase stack detected. Quick reminders:")
_console_print("\nπŸ’‘ Hint: Supabase stack detected. Quick reminders:")
_console_print(" - Enable RLS on every user-data table")
_console_print(" - Use getUser() not getSession() on the server")
_console_print(" - Keep SUPABASE_SERVICE_ROLE_KEY server-side only")
Expand Down Expand Up @@ -1397,7 +1386,9 @@ def cmd_scan(args):
_console_print(f"\nπŸ” AppGuardrail scanning: {scan_path}\n")

if run_codegraph:
_console_print("🧭 CodeGraph enabled: initializing or syncing structural index\n")
_console_print(
"🧭 CodeGraph enabled: initializing or syncing structural index\n"
)
try:
status = _run_codegraph_index(scan_path)
except RuntimeError as exc:
Expand Down Expand Up @@ -1435,9 +1426,13 @@ def cmd_scan(args):
if profile.frameworks:
_console_print(f" Framework signals: {', '.join(profile.frameworks)}")
if profile.external_tools:
_console_print(f" Optional external engines: {', '.join(profile.external_tools)}")
_console_print(
f" Optional external engines: {', '.join(profile.external_tools)}"
)
if profile.zap_recommended:
_console_print(" ZAP baseline: provide --zap-baseline <url> for authorized DAST")
_console_print(
" ZAP baseline: provide --zap-baseline <url> for authorized DAST"
)
_console_print()

external_plan = build_external_scan_plan(
Expand Down Expand Up @@ -1610,11 +1605,13 @@ def _write_findings_json(findings, output_path: Path):

def _is_safe_url(url: str) -> bool:
import ipaddress
import urllib.parse
import socket
import urllib.parse

try:
parsed = urllib.parse.urlparse(url) # nosemgrep: python.lang.security.audit.dynamic-urllib-use-detected.dynamic-urllib-use-detected
parsed = urllib.parse.urlparse(
url
) # nosemgrep: python.lang.security.audit.dynamic-urllib-use-detected.dynamic-urllib-use-detected
except ValueError:
return False

Expand Down Expand Up @@ -1771,7 +1768,7 @@ def cmd_fix(args):
s_suffix = "s" if count != 1 else ""
_console_print(f"βœ… Fixed {count} issue{s_suffix} in {f}")
except OSError as exc:
_console_print(f"❌ Could not write {f}: {exc}", file=sys.stderr)
_console_print(f"❌ Error: Could not write {f}: {exc}", file=sys.stderr)
return 1
else:
sys.stdout.writelines(
Expand Down Expand Up @@ -1799,7 +1796,9 @@ def cmd_fix(args):
f"\nπŸ”§ {total_fixes} safe fix{fix_s} available in {changed_files} file{file_s}. "
"Re-run with --apply to write them."
)
_console_print(" Other findings need review β€” see 'appguardrail report fix-pack'.")
_console_print(
" Other findings need review β€” see 'appguardrail report fix-pack'."
)
return 0


Expand Down Expand Up @@ -1837,7 +1836,9 @@ def cmd_report(args):
"""Generate markdown reports from normalized AppGuardrail findings JSON."""
report_type = getattr(args, "report_type", None)
if report_type not in supported_report_types():
_console_print(f"❌ Error: Unsupported report type: {report_type}", file=sys.stderr)
_console_print(
f"❌ Error: Unsupported report type: {report_type}", file=sys.stderr
)
_console_print(
"πŸ’‘ Hint: Supported report types are: "
+ ", ".join(supported_report_types()),
Expand Down Expand Up @@ -2021,13 +2022,13 @@ def cmd_hook(args):
elif [ -f "$APPGUARDRAIL_CLI" ]; then
python3 "$APPGUARDRAIL_CLI" scan{scan_flags} .
else
echo "\\n❌ AppGuardrail CLI not found."
echo "\\n❌ Error: AppGuardrail CLI not found."
echo "Install appguardrail or reinstall this hook from a trusted AppGuardrail checkout."
exit 127
fi

if [ $? -ne 0 ]; then
echo "\\n❌ AppGuardrail scan failed! Critical or high vulnerabilities found."
echo "\\n❌ Error: AppGuardrail scan failed! Critical or high vulnerabilities found."
echo "Please fix the issues or use '--no-verify' to bypass (not recommended)."
exit 1
fi
Expand Down Expand Up @@ -2096,7 +2097,9 @@ def _path_matches_glob(path: str, pattern: str) -> bool:


@functools.lru_cache(maxsize=2048)
def _path_allowed_by_rule_cached(path: str, include_paths: tuple, exclude_paths: tuple) -> bool:
def _path_allowed_by_rule_cached(
path: str, include_paths: tuple, exclude_paths: tuple
) -> bool:
"""Return whether a path passes optional YAML include/exclude filters (cached)."""
if include_paths and not any(
_path_matches_glob(path, glob) for glob in include_paths
Expand All @@ -2106,9 +2109,14 @@ def _path_allowed_by_rule_cached(path: str, include_paths: tuple, exclude_paths:
return False
return True


def _path_allowed_by_rule(path: str, include_paths, exclude_paths) -> bool:
"""Return whether a path passes optional YAML include/exclude filters."""
return _path_allowed_by_rule_cached(path, tuple(include_paths) if include_paths else (), tuple(exclude_paths) if exclude_paths else ())
return _path_allowed_by_rule_cached(
path,
tuple(include_paths) if include_paths else (),
tuple(exclude_paths) if exclude_paths else (),
)


def _collect_files(base_path: Path):
Expand Down Expand Up @@ -3010,18 +3018,32 @@ def _print_scan_results(findings, files_scanned):
_console_print("\n⚠️ No files were scanned. Are you in the right directory?")
elif counts["CRITICAL"] > 0:
issue_word = "issue" if counts["CRITICAL"] == 1 else "issues"
_console_print(_format_msg(f"\n❌ Critical {issue_word} found. Fix before deploying."))
_console_print(
_format_msg(
f"\n❌ Error: Critical {issue_word} found. Fix before deploying."
)
)
Comment thread
seonghobae marked this conversation as resolved.
elif counts["HIGH"] > 0:
issue_word = "issue" if counts["HIGH"] == 1 else "issues"
_console_print(_format_msg(f"\n⚠️ High-severity {issue_word} found. Review before deploying."))
_console_print(
_format_msg(
f"\n⚠️ High-severity {issue_word} found. Review before deploying."
)
)
elif not findings:
_console_print(_format_msg("\nβœ… No issues found in this scan."))
else:
_console_print(_format_msg("\nβœ… No deploy-blocking critical or high issues found."))
_console_print(
_format_msg("\nβœ… No deploy-blocking critical or high issues found.")
)

if findings:
these_word = "this issue" if len(findings) == 1 else "these issues"
_console_print(_format_msg(f"\nπŸ’‘ Run 'appguardrail review' to get an AI prompt for fixing {these_word}."))
_console_print(
_format_msg(
f"\nπŸ’‘ Hint: Run 'appguardrail review' to get an AI prompt for fixing {these_word}."
)
)
_console_print()


Expand Down Expand Up @@ -3049,10 +3071,14 @@ def cmd_review(args):
_console_print("═" * 60 + "\n")
_console_print(prompt)
_console_print("═" * 60 + "\n")
_console_print("πŸ’‘ Tips:")
_console_print("πŸ’‘ Hint: Tips:")
Comment thread
seonghobae marked this conversation as resolved.
_console_print(" - Paste this into Claude Code, Cursor, or any AI assistant")
_console_print(" - Include relevant files as context (API routes, DB schema, etc.)")
_console_print(" - Run 'appguardrail scan .' first to identify specific files to review")
_console_print(
" - Include relevant files as context (API routes, DB schema, etc.)"
)
_console_print(
" - Run 'appguardrail scan .' first to identify specific files to review"
)
_console_print()


Expand Down Expand Up @@ -3220,16 +3246,24 @@ def cmd_serve(args):
key_path = _api_key_output_path(args, db)
if key_path.exists():
conn.close()
_console_print(f"❌ API key file already exists: {key_path}", file=sys.stderr)
_console_print("πŸ’‘ Pass --api-key-file with a new path.", file=sys.stderr)
_console_print(
f"❌ Error: API key file already exists: {key_path}", file=sys.stderr
)
_console_print(
"πŸ’‘ Hint: Pass --api-key-file with a new path.", file=sys.stderr
)
return 1
oid, key = cp.create_org(conn, create)
conn.close()
try:
_persist_api_key(key_path, key)
except FileExistsError:
_console_print(f"❌ API key file already exists: {key_path}", file=sys.stderr)
_console_print("πŸ’‘ Pass --api-key-file with a new path.", file=sys.stderr)
_console_print(
f"❌ Error: API key file already exists: {key_path}", file=sys.stderr
)
_console_print(
"πŸ’‘ Hint: Pass --api-key-file with a new path.", file=sys.stderr
)
return 1
_console_print(f"βœ… Created org '{create}' (id {oid}).")
_console_print(f"πŸ”‘ API key written to {key_path}")
Expand All @@ -3238,16 +3272,24 @@ def cmd_serve(args):
key_path = _api_key_output_path(args, db)
if key_path.exists():
conn.close()
_console_print(f"❌ API key file already exists: {key_path}", file=sys.stderr)
_console_print("πŸ’‘ Pass --api-key-file with a new path.", file=sys.stderr)
_console_print(
f"❌ Error: API key file already exists: {key_path}", file=sys.stderr
)
_console_print(
"πŸ’‘ Hint: Pass --api-key-file with a new path.", file=sys.stderr
)
return 1
_oid, key = cp.create_org(conn, "default")
try:
_persist_api_key(key_path, key)
except FileExistsError:
conn.close()
_console_print(f"❌ API key file already exists: {key_path}", file=sys.stderr)
_console_print("πŸ’‘ Pass --api-key-file with a new path.", file=sys.stderr)
_console_print(
f"❌ Error: API key file already exists: {key_path}", file=sys.stderr
)
_console_print(
"πŸ’‘ Hint: Pass --api-key-file with a new path.", file=sys.stderr
)
return 1
_console_print("ℹ️ No orgs yet β€” created 'default'.")
_console_print(f"πŸ”‘ API key written to {key_path}\n")
Expand All @@ -3259,9 +3301,10 @@ def cmd_serve(args):
server = cp.make_control_plane_server(host, port, db)
except OSError as exc:
_console_print(
f"❌ Cannot start control plane on {host}:{port} ({exc}).", file=sys.stderr
f"❌ Error: Cannot start control plane on {host}:{port} ({exc}).",
file=sys.stderr,
)
_console_print("πŸ’‘ Pass a free port with --port.", file=sys.stderr)
_console_print("πŸ’‘ Hint: Pass a free port with --port.", file=sys.stderr)
return 1
actual = server.server_address[1]
_console_print(f"πŸ›°οΈ AppGuardrail control plane on http://{host}:{actual}")
Expand Down Expand Up @@ -3309,9 +3352,10 @@ def cmd_sbom(args):
Path(out).parent.mkdir(parents=True, exist_ok=True)
Path(out).write_text(payload + "\n", encoding="utf-8")
except OSError as exc:
_console_print(f"❌ Cannot write SBOM: {exc}", file=sys.stderr)
_console_print(f"❌ Error: Cannot write SBOM: {exc}", file=sys.stderr)
return 1
_console_print(f"πŸ“¦ SBOM ({len(components)} components) written: {out}")
component_word = "component" if len(components) == 1 else "components"
_console_print(f"πŸ“¦ SBOM ({len(components)} {component_word}) written: {out}")
else:
_console_print(payload)
return 0
Expand All @@ -3323,13 +3367,15 @@ def cmd_dashboard(args):

index = dashboard_index_path()
if not index.is_file():
_console_print(f"❌ Error: Dashboard assets not found at {index}", file=sys.stderr)
_console_print(
f"❌ Error: Dashboard assets not found at {index}", file=sys.stderr
)
_console_print(
"πŸ’‘ Hint: Check if the path is correct or if you are in the right directory.",
file=sys.stderr,
)
_console_print(
"πŸ’‘ Run 'appguardrail dashboard' from an AppGuardrail source checkout "
"πŸ’‘ Hint: Run 'appguardrail dashboard' from an AppGuardrail source checkout "
"that includes dashboard/index.html.",
file=sys.stderr,
)
Expand All @@ -3342,7 +3388,9 @@ def cmd_dashboard(args):
" Generate one with: "
"appguardrail scan --findings-json reports/findings.json ."
)
_console_print(" The dashboard opens with instructions β€” reload after generating.\n")
_console_print(
" The dashboard opens with instructions β€” reload after generating.\n"
)

tokens_css = b""
tokens_file = dashboard_tokens_path()
Expand All @@ -3364,8 +3412,13 @@ def cmd_dashboard(args):
host, port, index.read_bytes(), findings_path, tokens_css
)
except OSError as exc:
_console_print(f"❌ Cannot start dashboard on {host}:{port} ({exc}).", file=sys.stderr)
_console_print("πŸ’‘ Pass a free port with --port, e.g. --port 8899.", file=sys.stderr)
_console_print(
f"❌ Error: Cannot start dashboard on {host}:{port} ({exc}).",
file=sys.stderr,
)
_console_print(
"πŸ’‘ Hint: Pass a free port with --port, e.g. --port 8899.", file=sys.stderr
)
return 1

actual_port = server.server_address[1]
Expand Down
Loading
Loading