### Claude Code Setup Output Example

Source: https://github.com/akka/akka-sdk/blob/main/samples/ask-akka-agent/src/main/resources/md-docs/spec-your-first-agent.html.md

A sample output showing the verification status of dependencies and tools after running the setup command.

```none
/akka:setup — Complete

    Java 25 (Temurin)      ✓ installed
    Maven 3.9.11           ✓ installed
    Akka CLI dev-3.0.53    ✓ installed
    Akka download token    ⚠ could not verify (dot-directory restriction)
    Docker                 ✓ available
    MCP capabilities       ✓ all available (sdd, build, local, platform, git)
    SDK version            ✓ 3.5.16 (latest)
    Project scaffolded     ✓ com.example:akka-ssd-test-19
    Akka context docs      ✓ 203 files
    AI keys                ⏭ deferred (not needed for standard development)

  One thing to verify: I couldn't check ~/.m2/settings.xml due to the dot-directory permission restriction. If you haven't previously run `akka code token`, you'll need to do so before Maven can download Akka SDK dependencies. You can run it with `! akka code token` — it will open a browser for a free Akka account login.

  IMPORTANT: The MCP server configuration (.mcp.json) was created during setup. Claude Code only loads MCP servers at session start, so you need to restart. Use `claude --resume` to restart without losing your session context. After restarting, the Akka MCP tools will be available.

  Ready to go! After restarting, run /akka:specify to start building your first feature.
```

--------------------------------

### Examples of bucket configuration

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_config_set_object-storage_bucket.adoc

Examples demonstrating how to configure buckets for S3, GCS, and Azure Blob storage providers.

```bash
# s3 with static credentials
akka projects config set object-storage bucket photos \
  --provider s3 --bucket acme-photos --bucket-region us-east-1 \
  --credentials-type static \
  --access-key-id-secret aws-creds/access-key-id \
  --secret-access-key-secret aws-creds/secret-access-key

# gcs using the runtime's native credential chain
akka projects config set object-storage bucket logs \
  --provider gcs --bucket acme-logs --credentials-type native

# azure-blob with shared key
akka projects config set object-storage bucket archive \
  --provider azure-blob --bucket acme-archive \
  --credentials-type shared-key --account-name acmestorage \
  --account-key-secret azure-creds/account-key
```

--------------------------------

### Example of creating a project

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/operations/pages/projects/create-project.adoc

An example demonstrating how to create a project named 'my-akka-project' with a description, region, and organization.

```command
akka projects new my-akka-project "My Akka Project" --region=gcp-us-east1 --organization=my-organization
```

--------------------------------

### Install Akka CLI with Options (Linux/macOS)

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/operations/pages/cli/installation.adoc

Installs the Akka CLI with specific options like prefix, version, and verbosity. Use this for customized installations.

```bash
curl -sL https://doc.akka.io/install-cli.sh | bash -s -- --prefix=$HOME --version={akka-cli-version} --verbose
```

```bash
curl -sL https://doc.akka.io/install-cli.sh | bash -s -- -P $HOME -v {akka-cli-version} -V
```

--------------------------------

### Example usage of /akka.specify

Source: https://github.com/akka/akka-sdk/blob/main/samples/ask-akka-agent/src/main/resources/md-docs/specify.html.md

A practical example showing how to define a feature for managing application users.

```none
/akka:specify core users - The application manages its own users.
Users are uniquely identified by a username and authenticate via password.
Users can edit their profile and upload a small avatar image.
```

--------------------------------

### Akka Services Deploy Example

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/reference/pages/cli/akka-cli/akka_services_deploy.adoc

A practical example of deploying a service named my-service using a specific image.

```bash
akka services deploy my-service my-repo/my-service-image
```

--------------------------------

### Install Akka CLI on Linux

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/ROOT/partials/cli-install-short.adoc

Install the Akka CLI using the Debian package repository. This involves downloading a setup script and then installing the package.

```bash
curl -1sLf \
  'https://downloads.akka.io/setup.deb.sh' \
  | sudo -E bash
sudo apt install akka
```

--------------------------------

### Get Help for OIDC Authentication Setup

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/reference/pages/security/oidc-setup.adoc

Access help information for the 'akka organization auth add openid' command to understand all available options and parameters.

```command line
akka organization auth add openid --help
```

--------------------------------

### Example Output of Project Creation

Source: https://github.com/akka/akka-sdk/blob/main/samples/ask-akka-agent/src/main/resources/md-docs/create-project.html.md

This is an example of the output you can expect after successfully creating a new project using the Akka CLI.

```text
NAME              DESCRIPTION   ID                                     OWNER                                       REGION
my-akka-project   "My ..        xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx   id:"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"   gcp-us-east1

'my-akka-project' is now the currently active project.
```

--------------------------------

### Start MongoDB with Docker Compose

Source: https://github.com/akka/akka-sdk/blob/main/samples/ask-akka-agent/README.md

Use this command to start a pre-configured MongoDB instance for the sample.

```shell
docker-compose up -d
```

--------------------------------

### Configure Akka CLI installation options

Source: https://github.com/akka/akka-sdk/blob/main/samples/ask-akka-agent/src/main/resources/md-docs/installation.html.md

Pass specific flags to the installer script to define installation paths and versions.

```bash
curl -sL https://doc.akka.io/install-cli.sh | bash -s -- --prefix=$HOME --version=3.0.62 --verbose
curl -sL https://doc.akka.io/install-cli.sh | bash -s -- -P $HOME -v 3.0.62 -V
```

--------------------------------

### Verify Akka CLI Installation

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/ROOT/partials/cli-install-short.adoc

Verify that the Akka CLI has been installed successfully by running the help command. This lists all available commands.

```command window
akka help
```

--------------------------------

### Example output of listing regions

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/operations/pages/organizations/regions.adoc

This is an example of the output you can expect when listing available regions for an organization.

```command window
NAME            ORGANIZATION
aws-us-east-2   db805ff5-4fbd-4442-ab56-6e6a9a3c200a
```

--------------------------------

### Tagging Image Example

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/getting-started/pages/quick-deploy.adoc

Example output showing the successful tagging of a container image. Note the container name and tag for subsequent deployment steps.

```command line
DOCKER> Tagging image helloworld-agent:1.0-SNAPSHOT-20250630102843 successful!
```

--------------------------------

### Install Akka CLI on Linux/macOS (Alternative)

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/operations/pages/cli/installation.adoc

Installs the Akka CLI using a script from a URL. This is an alternative approach if the package manager method is not suitable.

```bash
curl -sL https://doc.akka.io/install-cli.sh | bash
```

--------------------------------

### Build Documentation with Examples

Source: https://github.com/akka/akka-sdk/blob/main/docs/PRETTIER_IGNORE_REMOVAL.md

Run this command to build the documentation locally, which includes the automatic removal of prettier-ignore comments.

```bash
# Local development
make local
```

```bash
# Production build
make prod
```

--------------------------------

### Check Akka CLI Version

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/operations/pages/cli/using-cli.adoc

Run this command to check the installed version of the Akka CLI. For update instructions, refer to the installation guide.

```shell
akka version
```

--------------------------------

### Match Names Starting with 'Jo'

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/reference/pages/views/syntax/operators/like.adoc

Example of using the LIKE operator to find records where the 'name' column starts with 'Jo'. This demonstrates prefix matching.

```sql
SELECT * FROM customers
WHERE name LIKE 'Jo%'
```

--------------------------------

### Initialize project and start container

Source: https://github.com/akka/akka-sdk/blob/main/samples/ask-akka-agent/src/main/resources/md-docs/dev-container.html.md

Create a new project using the Akka CLI and launch the dev container with the project directory mounted.

```bash
akka code init --name helloworld-agent --repo akka-samples/helloworld-agent.git
```

```bash
docker run -d --name akka-dev \
  -v "$(pwd)/helloworld-agent":/workspace \
  -p 9000:9000 \
  -p 9889:9889 \
  -e AKKA_RESOLVER_TOKEN \
  -e GOOGLE_AI_GEMINI_API_KEY \
  -e ANTHROPIC_API_KEY \
  -e OPENAI_API_KEY \
  registry.akka.io/akka-dev-container:latest
```

--------------------------------

### Complete Pagination Example with has_more Check

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/reference/pages/views/syntax/functions/page-token-offset.adoc

Shows a comprehensive pagination setup including filtering, sorting, token generation, and a check for remaining results.

```APIDOC
## Complete Pagination Example

### Description
Provides a full example of token-based pagination with filtering, sorting, next page token generation, and a has_more check.

### Syntax
```sql
SELECT * AS products,
       next_page_token() AS nextPageToken,
       has_more() AS hasMoreProducts
FROM products
WHERE category = :category
ORDER BY price ASC
OFFSET page_token_offset(:pageToken)
LIMIT 10
```

### Parameters
#### Query Parameters
- **pageToken** (string) - Required - The opaque token obtained from a previous query's `next_page_token()` function. Use an empty string for the first page request.
- **category** (string) - Required - The category to filter products by.
```

--------------------------------

### Initialize or clone the Akka project

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/getting-started/pages/author-your-first-service.adoc

Use the Akka CLI or Git to bootstrap the helloworld-agent project.

```command line
akka code init --name helloworld-agent --repo akka-samples/helloworld-agent.git
```

```command line
git clone https://github.com/akka-samples/helloworld-agent.git --depth 1
```

--------------------------------

### Page Token Offset Function Example

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/reference/pages/views/syntax/functions/index.adoc

The `page_token_offset(token)` function determines the starting position for pagination based on a provided token. It is used with the OFFSET clause.

```sql
OFFSET page_token_offset(:pageToken)
```

--------------------------------

### Initialize Akka Project

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/getting-started/pages/set-up-dev-env.adoc

Creates a new project from a sample repository using the Akka CLI.

```bash
akka code init --name helloworld-agent --repo akka-samples/helloworld-agent.git
```

--------------------------------

### Boot the application

Source: https://github.com/akka/akka-sdk/blob/main/samples/autonomous-agent-playground/specs/008-samples-web-ui/quickstart.md

Commands to compile and execute the Java application locally.

```bash
mvn compile -q
mvn exec:java -q
```

--------------------------------

### Integration test Counter Entity with TestKitSupport

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/sdk/pages/key-value-entities.adoc

Integration tests can be performed using TestKitSupport, which provides a component client for interacting with entities. This example demonstrates getting, increasing, and re-fetching the value of a counter entity.

```java
final CounterServiceClient counterServiceClient = CounterServiceClient.create(system).viaClientFlow();

// Get current value, expect 0
final GetValueReply getValueReply = counterServiceClient.getValue(GetValueRequest.newBuilder().setEntityId("bar").build()).toCompletableFuture().get();
assertThat(getValueReply.getValue()).isEqualTo(0);

// Increase value, expect 1
final IncreaseReply increaseReply = counterServiceClient.increase(IncreaseRequest.newBuilder().setEntityId("bar").build()).toCompletableFuture().get();
assertThat(increaseReply.getValue()).isEqualTo(1);

// Get current value again, expect 1
final GetValueReply getValueReply2 = counterServiceClient.getValue(GetValueRequest.newBuilder().setEntityId("bar").build()).toCompletableFuture().get();
assertThat(getValueReply2.getValue()).isEqualTo(1);
```

--------------------------------

### Set up gcloud environment

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/operations/pages/projects/broker-google-pubsub.adoc

Log in to gcloud, list projects, and set the current project for subsequent commands.

```command window
gcloud auth login
gcloud projects list
gcloud config set project <gcp-project-id>
```

--------------------------------

### Example Implementation Plan Summary

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/getting-started/pages/spec-your-first-agent.adoc

A sample output from Claude Code summarizing the implementation plan for a greeter agent.

```text
  Branch: 001-greeter-agent

  Generated Artifacts

  ┌───────────────────────────────────────────────┬──────────────────────────────────────┐
  │                     File                      │               Purpose                │
  ├───────────────────────────────────────────────┼──────────────────────────────────────┤
  │ specs/001-greeter-agent/plan.md               │ Implementation plan with component   │
  │                                               │ design                               │
  ├───────────────────────────────────────────────┼──────────────────────────────────────┤
  │                                               │ Decisions on session memory, model   │
  │ specs/001-greeter-agent/research.md           │ config, session ID strategy, error   │
  │                                               │ handling                             │
  ├───────────────────────────────────────────────┼──────────────────────────────────────┤
  │ specs/001-greeter-agent/data-model.md         │ Data model (API records only, no     │
  │                                               │ entities)                            │
  ├───────────────────────────────────────────────┼──────────────────────────────────────┤
  │ specs/001-greeter-agent/contracts/http-api.md │ HTTP API contract for POST /greet    │
  ├───────────────────────────────────────────────┼──────────────────────────────────────┤
  │ specs/001-greeter-agent/quickstart.md         │ Build, run, and test instructions    │
  └───────────────────────────────────────────────┴──────────────────────────────────────┘

  Architecture Summary

  - HelloWorldAgent — single Akka Agent with the verbatim system prompt, using SDK session
  memory and config-driven model provider
  - HelloWorldEndpoint — POST /greet accepting {"user": "...", "text": "..."}, using user as
   session ID, returning 500 on model config failure
  - No domain objects, no entities, no views — pure agent + endpoint
  - Tests — agent unit test with TestModelProvider, endpoint integration test with
  httpClient

  Constitution Check

  All four principles pass: Akka SDK First, Design Principles, Test Coverage, Simplicity.
```

--------------------------------

### Install Akka CLI on macOS

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/ROOT/partials/cli-install-short.adoc

Install the Akka CLI on macOS using Homebrew. Ensure Homebrew is installed before running this command.

```bash
brew install akka/brew/akka
```

--------------------------------

### Initialize Akka Project with Akka CLI

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/ROOT/partials/create-the-empty-project.adoc

Use this command to create a new Akka project with a specified name and repository template. Ensure the Akka CLI is installed.

```command line
akka code init --name helloworld-agent --repo akka-samples/empty.git
```

--------------------------------

### Install Akka CLI with Custom Prefix (Linux/macOS)

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/operations/pages/cli/installation.adoc

Installs the Akka CLI to a specified prefix, useful for avoiding permission issues or custom installations.

```bash
curl -sL https://doc.akka.io/install-cli.sh | bash -s -- --prefix /tmp && \
    sudo mv /tmp/akka /usr/local/bin/akka
```

--------------------------------

### Install Akka CLI on Windows

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/ROOT/partials/cli-install-short.adoc

Install the Akka CLI on Windows using the winget package manager. This command installs the Akka CLI from the available package sources.

```powershell
winget install Akka.Cli
```

--------------------------------

### Build and Open Documentation Locally

Source: https://github.com/akka/akka-sdk/blob/main/docs/README.md

Execute this command to build the full documentation site using a Docker-based process. The output will be in the target/site directory.

```bash
make local open
```

--------------------------------

### Example McpEndpoint.java

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/sdk/pages/mcp-endpoints.adoc

An example of how to create an MCP endpoint class annotated with @McpEndpoint.

```APIDOC
## @McpEndpoint

### Description
Annotates a class to designate it as an MCP endpoint, making its methods available to MCP clients.

### Usage
```java
@McpEndpoint
public class MyMcpService {
    // ... endpoint methods ...
}
```
```

--------------------------------

### Install Asciidoctor

Source: https://github.com/akka/akka-sdk/blob/main/docs/README-vale.md

Install Asciidoctor, a dependency required for processing .adoc files with Vale.

```bash
gem install asciidoctor
```

--------------------------------

### Complete Pagination Example

Source: https://github.com/akka/akka-sdk/blob/main/samples/ask-akka-agent/src/main/resources/md-docs/page-token-offset.html.md

A complete pagination example including has_more check and filtering.

```APIDOC
## Complete pagination example with has_more check

```sql
SELECT * AS products,
       next_page_token() AS nextPageToken,
       has_more() AS hasMoreProducts
FROM products
WHERE category = :category
ORDER BY price ASC
OFFSET page_token_offset(:pageToken)
LIMIT 10
```
```

--------------------------------

### Implement Service Lifecycle with ServiceSetup

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/sdk/pages/setup-and-dependency-injection.adoc

Create a class annotated with @Setup implementing ServiceSetup to define logic for service startup and shutdown.

```java
@Setup
public class Bootstrap implements ServiceSetup {
  private final MyDatabaseConnection connection;

  public Bootstrap(Config config) { // <2>
    this.connection = new MyDatabaseConnection(config.getString("db.url"));
  }

  @Override
  public void onStartup() { // <3>
    connection.connect();
  }

  @Override
  public void onShutdown() { // <4>
    connection.close();
  }
}
```

--------------------------------

### Verify Docker installation

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/operations/pages/projects/container-registries.adoc

Confirm that Docker is installed and accessible on your system by checking its version.

```command line
> docker --version
Docker version 27.3.1, build ce1223035a
```

--------------------------------

### Initialize GCP Environment

Source: https://github.com/akka/akka-sdk/blob/main/samples/ask-akka-agent/src/main/resources/md-docs/external-secrets.html.md

Configures the GCP project and authenticates the CLI.

```command
export GCP_PROJECT_ID=my-gcp-project
gcloud auth login
gcloud config set project $GCP_PROJECT_ID
```

--------------------------------

### Install Vale using Homebrew

Source: https://github.com/akka/akka-sdk/blob/main/docs/README-vale.md

Use this command to install Vale on macOS via Homebrew.

```bash
brew install vale
```

--------------------------------

### Example Container Tag Output

Source: https://github.com/akka/akka-sdk/blob/main/samples/ask-akka-agent/src/main/resources/md-docs/build-and-deploy-shopping-cart.html.md

Sample output showing the generated container name and tag after a successful build.

```command
DOCKER> Tagging image shoppingcart:1.0-SNAPSHOT-20241028102843 successful!
```

--------------------------------

### Open Local Documentation

Source: https://github.com/akka/akka-sdk/blob/main/docs/README.md

After building the documentation, open the index.html file in your web browser using this command.

```bash
open ../target/site/index.html
```

--------------------------------

### Example component output

Source: https://github.com/akka/akka-sdk/blob/main/samples/ask-akka-agent/src/main/resources/md-docs/using-cli.html.md

Sample output format showing component names, types, and type IDs.

```text
NAME                                     TYPE           TYPE ID
com.example.api.ShoppingCartController   HttpEndpoint
com.example.api.ShoppingCartEntity       KeyValueEntity shopping-cart
```

--------------------------------

### Build and run the application

Source: https://github.com/akka/akka-sdk/blob/main/samples/multi-agent/README.md

Use Maven to compile and execute the application.

```shell
# Run the application
mvn compile exec:java
```

--------------------------------

### Install Akka CLI on Linux via Debian repository

Source: https://github.com/akka/akka-sdk/blob/main/samples/ask-akka-agent/src/main/resources/md-docs/installation.html.md

Use the Debian package repository for the recommended Linux installation.

```bash
curl -1sLf \
  'https://downloads.akka.io/setup.deb.sh' \
  | sudo -E bash
sudo apt install akka
```

--------------------------------

### Create a task

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/sdk/pages/autonomous-agents/client.adoc

Initializes a new task with specific instructions.

```java
var taskId = UUID.randomUUID().toString();
componentClient
  .forTask(taskId)
  .create(PipelineTasks.COLLECT.instructions("Collect data on: " + topic));
```

--------------------------------

### Synopsis for instance-types list

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_instance-types_list.adoc

Basic usage pattern for listing project instance types.

```bash
akka projects instance-types list [flags]
```

--------------------------------

### Synopsis for bucket configuration

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_config_set_object-storage_bucket.adoc

The basic command structure for setting an object-storage bucket.

```bash
akka projects config set object-storage bucket NAME [flags]
```

--------------------------------

### Install Akka Plugin in Claude Code

Source: https://github.com/akka/akka-sdk/blob/main/samples/ask-akka-agent/src/main/resources/md-docs/spec-your-first-agent.html.md

Commands to add, install, and reload the Akka plugin within the Claude Code environment.

```none
/plugin marketplace add akka/ai-marketplace
/plugin install akka@ai-marketplace
/reload-plugins
/akka:setup
```

--------------------------------

### Initialize a new spec-driven project

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/getting-started/pages/spec-your-first-agent.adoc

Commands to initialize a new Akka project directory using the CLI.

```bash
akka specify init helloworld-agent
```

```bash
akka specify init .
```

--------------------------------

### Install and upgrade Akka CLI on Windows via winget

Source: https://github.com/akka/akka-sdk/blob/main/samples/ask-akka-agent/src/main/resources/md-docs/installation.html.md

Use the Windows Package Manager to install or upgrade the Akka CLI.

```powershell
winget install Akka.Cli
```

```powershell
winget upgrade Akka.Cli
```

--------------------------------

### YAML System Configuration Example

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/operations/pages/cli/system-config.adoc

Use this YAML format to configure system-level settings for the Akka CLI. Settings not specified will use default values.

```yaml
code-templates-url: https://internal.example.com/akka-templates.json
context-url: https://internal.example.com/akka-context.zip
context-subdir: akka-context
```

--------------------------------

### Example Workload Identity Token Subject Claim

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/operations/pages/services/workload-identity.adoc

An example of a token subject claim for a service named 'my-service' in project 'bc16cf0c-909f-402d-bbb0-88ea1d582854'.

```text
system:serviceaccount:bc16cf0c-909f-402d-bbb0-88ea1d582854:klx-my-service
```

--------------------------------

### Create a new project with CLI

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/operations/pages/projects/create-project.adoc

Create a new project by specifying its name, description, region, and organization. The description should be enclosed in quotes.

```command
akka projects new <project name> "<project description>" --region=<region> --organization=<org>
```

--------------------------------

### Get Shopping Cart Details

Source: https://github.com/akka/akka-sdk/blob/main/samples/key-value-shopping-cart/README.md

Retrieve the details of a specific shopping cart by sending a GET request to the /carts/{cartId} endpoint.

```shell
curl localhost:9000/carts/cart1
```

--------------------------------

### Install Akka Specify Plugin in Claude Code

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/getting-started/pages/set-up-dev-env.adoc

Commands to add the marketplace and install the Akka plugin within the Claude Code environment.

```text
/plugin marketplace add akka/ai-marketplace
/plugin install akka@ai-marketplace
/reload-plugins
```

--------------------------------

### Initialize a Spec-Driven Project

Source: https://github.com/akka/akka-sdk/blob/main/samples/ask-akka-agent/src/main/resources/md-docs/spec-driven-development.html.md

Use this command to scaffold a new project directory with the necessary markdown templates for spec-driven development.

```shell
akka specify init <dir>
```

--------------------------------

### Execute constitution command

Source: https://github.com/akka/akka-sdk/blob/main/samples/ask-akka-agent/src/main/resources/md-docs/constitution.html.md

Run this command to initialize or update the project constitution file.

```none
/akka:constitution
```

--------------------------------

### Curl Request Example

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/getting-started/pages/ask-akka-agent/the-agent.adoc

Example using curl to send a POST request to the local Akka service endpoint with a JSON payload.

```command line
curl localhost:9000/api/ask --header "Content-Type: application/json" -XPOST \
--data '{ "userId": "001", "sessionId": "foo", 
          "question":"What are the core components of Akka?"}'
```

--------------------------------

### Clone Project Repository

Source: https://github.com/akka/akka-sdk/blob/main/samples/ask-akka-agent/src/main/resources/md-docs/activity.html.md

Alternative method to initialize the project by cloning the repository directly.

```command
git clone https://github.com/akka-samples/empty.git --depth 1
```

--------------------------------

### Complete Pagination Example

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/reference/pages/views/syntax/limit.adoc

A comprehensive pagination example combining filtering, sorting, and various pagination indicators like `next_page_token()`, `has_more()`, and `total_count()` with `LIMIT`.

```sql
SELECT * AS products,
       next_page_token() AS nextPageToken,
       has_more() AS hasMore,
       total_count() AS totalCount
FROM products
WHERE category = :category
ORDER BY price ASC
LIMIT :pageSize
```

--------------------------------

### Instance-types command help

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/reference/pages/cli/akka-cli/akka_projects_instance-types.adoc

Displays help information for the instance-types command.

```text
  -h, --help   help for instance-types
```

--------------------------------

### Akka Service Descriptor Example

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/operations/pages/services/deploy-service.adoc

An example of a service descriptor YAML file, specifying service name, runtime mode, image, and environment variables.

```yaml
name: my-service
service:
  resources:
    runtime:
      mode: embedded
  image: acr.us-east-1.akka.io/my-organization/my-project/container-name:tag-name
  env:
  - name: SOME_VARIABLE
    value: some value
```

--------------------------------

### Example ACR image path for deployment

Source: https://github.com/akka/akka-sdk/blob/main/docs/src/modules/operations/pages/services/deploy-service.adoc

This is an example of the primary region image tag that should be used when deploying an Akka service after pushing to ACR.

```command line
acr.us-east-1.akka.io/my-organization/my-project/container-name:tag-name
```