grep

Search content by pattern

Search for content matching a regular expression pattern within files.

Python SDK

from openviking import OpenViking

client = OpenViking()

# Search for a pattern
results = client.grep(
    "viking://resources/",
    "authentication",
    case_insensitive=True
)

print(f"Found {results['count']} matches")
for match in results['matches']:
    print(f"  {match['uri']}:{match['line']}")
    print(f"    {match['content']}")

HTTP API

cURL

curl -X POST http://localhost:1933/api/v1/search/grep \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-key" \
  -d '{
    "uri": "viking://resources/",
    "pattern": "authentication",
    "case_insensitive": true
  }'

POST /api/v1/search/grep

{
  "uri": "viking://resources/",
  "pattern": "authentication",
  "case_insensitive": true
}

Parameters

uri · string · required

Viking URI to search in (file or directory)

pattern · string · required

Regular expression pattern to search for

case_insensitive · boolean · default: "false"

Ignore case when matching

node_limit · integer

Maximum number of files to search

Response

status · string

Operation status (ok on success)

result · object

Search results

Show properties

matches · array

Array of match objects

Show match object

uri · string

Viking URI of the file containing the match

line · integer

Line number (1-based)

content · string

The matching line content

count · integer

Total number of matches found

time · number

Execution time in seconds

{
  "status": "ok",
  "result": {
    "matches": [
      {
        "uri": "viking://resources/docs/auth.md",
        "line": 15,
        "content": "User authentication is handled by the AuthService class."
      },
      {
        "uri": "viking://resources/docs/api.md",
        "line": 42,
        "content": "All API endpoints require authentication via bearer token."
      }
    ],
    "count": 2
  },
  "time": 0.3
}

CLI

openviking grep viking://resources/ "authentication" [--ignore-case]

Pattern Syntax

The pattern parameter accepts standard regular expressions:

• authentication - Literal string match
• auth.*token - Match “auth” followed by any characters, then “token”
• ^import - Match lines starting with “import”
• TODO|FIXME - Match lines containing either “TODO” or “FIXME”

Performance Notes

• Searching large directories may take time
• Use node_limit to restrict the number of files searched
• Directories are searched recursively by default