Openship-App: Instructions file for GitHub Copilot

.github/copilot-instructions.md

Openship-App copilot-instructions.md is an instructions file for GitHub Copilot from kareemessam09/Openship-App. It costs 684 tokens per session, scanned A, original, Apache-2.0.

Project-specific coding instructions for an unofficial Android client for Openship, a self-hostable deployment platform. They describe its Kotlin Multiplatform and Compose architecture, networking, and coding rules.

In plain words
What is it for?
Use them when adding or changing networking, data models, real-time build logs, monitoring, Android UI, dependency injection, or navigation in this project.
Why use it?
They give a coding agent the project context and constraints needed to make changes that fit the existing Android and shared-code structure.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file.

This is kareemessam09/Openship-App's own configuration. It tells GitHub Copilot how to work on Openship-App itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything Openship-App configures →

Reuse

Borrowing it

Nothing to install: this file belongs to kareemessam09/Openship-App. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/kareemessam09/Openship-App/master/.github/copilot-instructions.md
Clone the repo
git clone --depth 1 https://github.com/kareemessam09/Openship-App

Made for: GitHub Copilot.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for Openship-App copilot-instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/kareemessam09/openship-app/copilot-instructions/github.svg)](https://agentmods.dev/instructions/kareemessam09/openship-app/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/kareemessam09/openship-app/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/kareemessam09/openship-app/copilot-instructions/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for Openship-App copilot-instructions.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/kareemessam09/openship-app/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/kareemessam09/openship-app/copilot-instructions.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 684 This file is loaded in full into every session.
When invoked 684 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00684 $0.00684
Opus 5.5 $0.00274 $0.00274
Sonnet 5.5 $0.00137 $0.00137
Haiku 4.5 $0.00068 $0.00068

Measured 2mo ago against content hash 494782d53ea1, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

Openship-App copilot-instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/copilot-instructions.md · 51 lines

How it starts

The opening of the file, as written. The whole thing — 51 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Openship-App — GitHub Copilot Instructions

Project

Unofficial Android client for Openship (self-hostable deployment platform). KMP + Compose Multiplatform. MCP as primary API layer, SSE for real-time streams.

Tech Stack

  • Kotlin 2.4.10, Compose Multiplatform 1.11.1, AGP 9.0.1
  • compileSdk 36, minSdk 24, JDK 21
  • Planned: Ktor 3.5.2, Kotlin MCP SDK 0.15.0, Koin 4.x, kotlinx.serialization 1.11.0
  • Package: com.kareemessam.openship (app), com.kareemessam.openship.shared (shared)

Architecture

  • shared/ (KMP): commonMain = networking (MCP + SSE), models, repository. androidMain = Keystore, OkHttp engine.
  • androidApp/ (Android): Compose UI, ViewModels, Koin DI, navigation.
  • One shared Ktor HttpClient for both MCP transport and SSE streams.
  • MCP for discrete ops (health, list projects). SSE for real-time (build logs, monitoring).

Key Rules

  • All networking code in shared/commonMain/ — no Android imports in commonMain.
  • Platform-specific code in shared/androidMain/platform/.
  • Use @Serializable data classes with Json { ignoreUnknownKeys = true } (API has no versioning).
  • SSE log event data field is base64-encoded — decode before display.
  • Track eventId/seq for deploy log resume (?since=<seq> on reconnect).
  • Don't hold MCP Client or SSE streams across backgrounding — reconnect on foreground.
  • Monitoring SSE 404s in CLOUD_MODE — hide monitor tab for cloud instances.
  • Use Ktor SSE plugin (NOT EventSource — can't set Authorization headers).
  • Add dependencies to gradle/libs.versions.toml first, then reference in build.gradle.kts.

API Endpoints (Base: {instanceUrl})

  • GET /api/health/env — discovery, public, returns authMode
  • GET /api/projects/home — list projects, PAT auth, tag project:list
  • GET /api/deployments/:id/stream — SSE build logs, PAT auth, ?since=<seq> for replay
  • GET /api/system/monitor/stream?serverId=<id> — SSE server metrics, PAT auth, 3s interval

Auth

  • PAT: Authorization: Bearer opsh_pat_<43-char base64url>
  • Modes: none (loopback), local (better-auth), cloud (PKCE OAuth)
  • Store in EncryptedSharedPreferences (Android Keystore)

Read the full file on GitHub · 51 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2mo ago First seen · 51 lines · 684 tokens per session scan A 494782d53ea1

Subscribe to this mod's changes

Openship-App copilot-instructions.md is an instructions file published in the GitHub repository kareemessam09/Openship-App (11 stars, last pushed 2mo ago), licensed Apache-2.0. It adds 684 tokens to every session, about $0.0027 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Openship-App copilot-instructions.md compared with instructions from other repositories

Openship-App copilot-instructions.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
Openship-App copilot-instructions.mdkareemessam09/Openship-AppInstructions file112mo agoApache-2.0A684GitHub Copilot
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143ktodayMITA7,461Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchainInstructions file149ktodayMITA4,680Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA5,516GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA3,093GitHub Copilot
vscode ai-customization.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA1,907GitHub Copilot