From 05c568126fd0c1003dcfdee8650a6cd6013b259f Mon Sep 17 00:00:00 2001 From: Jaana Dogan Date: Tue, 22 Apr 2025 16:17:37 -0700 Subject: [PATCH] Add a tip about creating an alias during development (#122) Identical to #118, it's lost while we were recovering the main branch. --- CONTRIBUTING.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8956a61b..e8ccc355 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,3 +30,43 @@ Guidelines](https://opensource.google/conduct/). All submissions, including submissions by project members, require review. We use [GitHub pull requests](https://docs.github.com/articles/about-pull-requests) for this purpose. + +### gemini-code alias + +During development phase, you can use the following to create an alias for +the command line tool: + +```bash +$ npm run build +$ alias gemini-code="node /path/to/gemini-code/packages/cli/dist/index.js" +$ gemini-code + ██████╗ ███████╗███╗ ███╗██╗███╗ ██╗██╗ +██╔════╝ ██╔════╝████╗ ████║██║████╗ ██║██║ +██║ ███╗█████╗ ██╔████╔██║██║██╔██╗ ██║██║ +██║ ██║██╔══╝ ██║╚██╔╝██║██║██║╚██╗██║██║ +╚██████╔╝███████╗██║ ╚═╝ ██║██║██║ ╚████║██║ + ╚═════╝ ╚══════╝╚═╝ ╚═╝╚═╝╚═╝ ╚═══╝╚═╝ + + ██████╗ ██████╗ ██████╗ ███████╗ +██╔════╝██╔═══██╗██╔══██╗██╔════╝ +██║ ██║ ██║██║ ██║█████╗ +██║ ██║ ██║██║ ██║██╔══╝ +╚██████╗╚██████╔╝██████╔╝███████╗ + ╚═════╝ ╚═════╝ ╚═════╝ ╚══════╝ + + +Tips for getting started: +1. /help for more information. +2. /init to create a GEMINI.md for instructions & context. +3. Ask coding questions, edit code or run commands. +4. Be specific for the best results. + +cwd: /Users/jbd/gemini-code +╭────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│ > Enter your message or use tools... │ +╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + +? for shortcuts Gemini + +Note: Flickering may occur in iTerm. +```