diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile new file mode 100644 index 00000000..311d687b --- /dev/null +++ b/.devcontainer/Dockerfile @@ -0,0 +1,5 @@ +FROM mcr.microsoft.com/devcontainers/base:ubuntu + +RUN apt-get update \ + && apt-get install -y --no-install-recommends postgresql-client \ + && rm -rf /var/lib/apt/lists/* diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 00000000..c5d85d47 --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,17 @@ +{ + "name": "Codex Dev Container", + "dockerComposeFile": [ + "../docker-compose.yml" + ], + "service": "app", + "workspaceFolder": "/workspaces/codex", + "shutdownAction": "stopCompose", + "customizations": { + "vscode": { + "extensions": [ + "ms-azuretools.vscode-docker", + "ms-python.python" + ] + } + } +} diff --git a/.env.example b/.env.example new file mode 100644 index 00000000..951f8125 --- /dev/null +++ b/.env.example @@ -0,0 +1,5 @@ +OPENAI_API_KEY=your_openai_api_key_here +POSTGRES_USER=codex +POSTGRES_PASSWORD=__SET_SECURE_PASSWORD__ +POSTGRES_DB=codex +POSTGRES_PORT=5432 diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..45b0e0d5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,29 @@ +# Environment +.env +.env.* +!.env.example + +# OS / Editor +.DS_Store +Thumbs.db +.vscode/ +.idea/ + +# Python +__pycache__/ +*.py[cod] +.pytest_cache/ +.venv/ +venv/ + +# Node +node_modules/ +.npm/ + +# Logs & caches +*.log +.cache/ + +# Build artifacts +dist/ +build/ diff --git a/README.md b/README.md index 347cf2dc..44500bfb 100644 --- a/README.md +++ b/README.md @@ -1,194 +1,65 @@ -# GitHub Copilot CLI +# Codex -The power of GitHub Copilot, now in your terminal. +Repozytorium projektu **Codex** z przygotowanym szkieletem do dalszego rozwoju, obejmującym dokumentację, kod aplikacji, dane, skrypty automatyzacji oraz środowisko deweloperskie oparte na Dev Container i Docker Compose. -GitHub Copilot CLI brings AI-powered coding assistance directly to your command line, enabling you to build, debug, and understand code through natural language conversations. Powered by the same agentic harness as GitHub's Copilot coding agent, it provides intelligent assistance while staying deeply integrated with your GitHub workflow. +## Struktura katalogów -See [our official documentation](https://docs.github.com/copilot/concepts/agents/about-copilot-cli) for more information. +- `.devcontainer/` – konfiguracja środowiska deweloperskiego w kontenerze. +- `src/` – kod źródłowy aplikacji. +- `docs/` – dokumentacja i zebrane informacje projektowe. +- `data/` – dane lokalne/pliki pomocnicze wykorzystywane w projekcie. +- `scripts/` – skrypty narzędziowe i automatyzujące. -![Image of the splash screen for the Copilot CLI](https://github.com/user-attachments/assets/f40aa23d-09dd-499e-9457-1d57d3368887) +## Dev Container +Wymagania: +- Docker Desktop / Docker Engine +- VS Code + rozszerzenie **Dev Containers** -## 🚀 Introduction and Overview +Uruchomienie: +1. Skopiuj plik środowiskowy: + ```bash + cp .env.example .env + ``` +2. Otwórz repozytorium w VS Code. +3. Wybierz: **Dev Containers: Reopen in Container**. -We're bringing the power of GitHub Copilot coding agent directly to your terminal. With GitHub Copilot CLI, you can work locally and synchronously with an AI agent that understands your code and GitHub context. +Konfiguracja korzysta z Docker Compose (`docker compose`), dzięki czemu kontener deweloperski działa razem z bazą danych. -- **Terminal-native development:** Work with Copilot coding agent directly in your command line — no context switching required. -- **GitHub integration out of the box:** Access your repositories, issues, and pull requests using natural language, all authenticated with your existing GitHub account. -- **Agentic capabilities:** Build, edit, debug, and refactor code with an AI collaborator that can plan and execute complex tasks. -- **MCP-powered extensibility:** Take advantage of the fact that the coding agent ships with GitHub's MCP server by default and supports custom MCP servers to extend capabilities. -- **Full control:** Preview every action before execution — nothing happens without your explicit approval. - -We're still early in our journey, but with your feedback, we're rapidly iterating to make the GitHub Copilot CLI the best possible companion in your terminal. - -## 📦 Getting Started - -### Supported Platforms - -- **Linux** -- **macOS** -- **Windows** - -### Prerequisites - -- (On Windows) **PowerShell** v6 or higher -- An **active Copilot subscription**. See [Copilot plans](https://github.com/features/copilot/plans?ref_cta=Copilot+plans+signup&ref_loc=install-copilot-cli&ref_page=docs). - -If you have access to GitHub Copilot via your organization or enterprise, you cannot use GitHub Copilot CLI if your organization owner or enterprise administrator has disabled it in the organization or enterprise settings. See [Managing policies and features for GitHub Copilot in your organization](http://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/managing-policies-for-copilot-in-your-organization) for more information. - -### Installation - -Install with the install script (macOS and Linux): - -```bash -curl -fsSL https://gh.io/copilot-install | bash -``` - -Or - -```bash -wget -qO- https://gh.io/copilot-install | bash -``` - -Use `| sudo bash` to run as root and install to `/usr/local/bin`. - -Set `PREFIX` to install to `$PREFIX/bin/` directory. Defaults to `/usr/local` -when run as root or `$HOME/.local` when run as a non-root user. - -Set `VERSION` to install a specific version. Defaults to the latest version. - -For example, to install version `v0.0.369` to a custom directory: - -```bash -curl -fsSL https://gh.io/copilot-install | VERSION="v0.0.369" PREFIX="$HOME/custom" bash -``` - -Install with [Homebrew](https://formulae.brew.sh/cask/copilot-cli) (macOS and Linux): - -```bash -brew install copilot-cli -``` +## Baza danych (Docker Compose) +Start usług: ```bash -brew install copilot-cli@prerelease -``` - - -Install with [WinGet](https://github.com/microsoft/winget-cli) (Windows): - -```bash -winget install GitHub.Copilot +docker compose up -d ``` +Zatrzymanie usług: ```bash -winget install GitHub.Copilot.Prerelease +docker compose down ``` +Domyślne ustawienia PostgreSQL: +- host: `localhost` +- port: `5432` +- user: `codex` +- password: wartość `POSTGRES_PASSWORD` z pliku `.env` +- database: `codex` +- volume: `postgres_data` -Install with [npm](https://www.npmjs.com/package/@github/copilot) (macOS, Linux, and Windows): - -```bash -npm install -g @github/copilot -``` - -```bash -npm install -g @github/copilot@prerelease -``` +> ⚠️ Ustaw własne, silne hasło `POSTGRES_PASSWORD` w `.env` przed uruchomieniem usług. +## Zmienne środowiskowe (OpenAI) -### Launching the CLI +W projekcie używany jest plik `.env` (lokalnie, niecommitowany). Bazuj na `.env.example` i ustaw swój klucz: -```bash -copilot +```env +OPENAI_API_KEY=your_openai_api_key_here ``` -On first launch, you'll be greeted with our adorable animated banner! If you'd like to see this banner again, launch `copilot` with the `--banner` flag. - -If you're not currently logged in to GitHub, you'll be prompted to use the `/login` slash command. Enter this command and follow the on-screen instructions to authenticate. - -#### Authenticate with a Personal Access Token (PAT) - -You can also authenticate using a fine-grained PAT with the "Copilot Requests" permission enabled. - -1. Visit https://github.com/settings/personal-access-tokens/new -2. Under "Permissions," click "add permissions" and select "Copilot Requests" -3. Generate your token -4. Add the token to your environment via the environment variable `GH_TOKEN` or `GITHUB_TOKEN` (in order of precedence) - -### Using the CLI - -Launch `copilot` in a folder that contains code you want to work with. - -By default, `copilot` utilizes Claude Sonnet 4.5. Run the `/model` slash command to choose from other available models, including Claude Sonnet 4 and GPT-5. - -### Experimental Mode - -Experimental mode enables access to new features that are still in development. You can activate experimental mode by: - -- Launching with the `--experimental` flag: `copilot --experimental` -- Using the `/experimental` slash command from within the CLI - -Once activated, the setting is persisted in your config, so the `--experimental` flag is no longer needed on subsequent launches. - -#### Experimental Features - -- **Autopilot mode:** Autopilot is a new mode (press `Shift+Tab` to cycle through modes), which encourages the agent to continue working until a task is completed. - -Each time you submit a prompt to GitHub Copilot CLI, your monthly quota of premium requests is reduced by one. For information about premium requests, see [About premium requests](https://docs.github.com/copilot/managing-copilot/monitoring-usage-and-entitlements/about-premium-requests). - -For more information about how to use the GitHub Copilot CLI, see [our official documentation](https://docs.github.com/copilot/concepts/agents/about-copilot-cli). +Ta zmienna będzie wykorzystywana przez komponenty aplikacji rozwijane w `src/` (np. moduły integracji z API OpenAI). -## 🔧 Configuring LSP Servers - -GitHub Copilot CLI supports Language Server Protocol (LSP) for enhanced code intelligence. This feature provides intelligent code features like go-to-definition, hover information, and diagnostics. - -### Installing Language Servers - -Copilot CLI does not bundle LSP servers. You need to install them separately. For example, to set up TypeScript support: +Możesz też wyeksportować zmienną w shellu: ```bash -npm install -g typescript-language-server -``` - -For other languages, install the corresponding LSP server and configure it following the same pattern shown below. - -### Configuring LSP Servers - -LSP servers are configured through a dedicated LSP configuration file. You can configure LSP servers at the user level or repository level: - -**User-level configuration** (applies to all projects): -Edit `~/.copilot/lsp-config.json` - -**Repository-level configuration** (applies to specific project): -Create `.github/lsp.json` in your repository root - -Example configuration: - -```json -{ - "lspServers": { - "typescript": { - "command": "typescript-language-server", - "args": ["--stdio"], - "fileExtensions": { - ".ts": "typescript", - ".tsx": "typescript" - } - } - } -} +export OPENAI_API_KEY="your_openai_api_key_here" ``` - -### Viewing LSP Server Status - -Check configured LSP servers using the `/lsp` command in an interactive session, or view your configuration files directly. - -For more information, see the [changelog](./changelog.md). - -## 📢 Feedback and Participation - -We're excited to have you join us early in the Copilot CLI journey. - -We're building quickly. Expect frequent updates--please keep your client up to date for the latest features and fixes! - -Your insights are invaluable! Open an issue in this repo, join Discussions, and run `/feedback` from the CLI to submit a confidential feedback survey! diff --git a/data/.gitkeep b/data/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 00000000..f7316fe6 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,28 @@ +services: + app: + build: + context: . + dockerfile: .devcontainer/Dockerfile + command: sleep infinity + env_file: + - path: .env + required: false + volumes: + - .:/workspaces/codex:cached + depends_on: + - db + + db: + image: postgres:16-alpine + restart: unless-stopped + ports: + - "${POSTGRES_PORT:-5432}:5432" + environment: + POSTGRES_USER: ${POSTGRES_USER:-codex} + POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:?Set POSTGRES_PASSWORD in .env} + POSTGRES_DB: ${POSTGRES_DB:-codex} + volumes: + - postgres_data:/var/lib/postgresql/data + +volumes: + postgres_data: diff --git a/docs/.gitkeep b/docs/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/scripts/.gitkeep b/scripts/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/src/.gitkeep b/src/.gitkeep new file mode 100644 index 00000000..e69de29b