Skip to main content

This tool safely and securely analyzes applications for benchmarking.

Project description

Contributor Covenant

TechLens™ Agent

TechLens Agent™ is one of many tools Crosslake uses to guide your critical technology decisions with data-driven confidence. To learn more, drop us a note at: techlens@crosslaketech.com.

Requirements:

  • Python3 - Test with python3 --version
  • pip - Test with pip -V
  • SSH access to code repositories - Test with git status
  • Command line tool access to cloud hosting providers
  • Admin privileges on the computer used to run the agent (not required but recommended)
  • Outbound internet access (for posting results and fetching dependency metadata)
  • Your dependency management tools (e.g. npm or yarn or maven)

To run the Agent:

  • Download the techlens-agent binary from crosslake
  • Run the agent techlens-agent --config=/path/to/config

Config Options

  • If you want to check the output for yourself you can set should_upload: false, and use the flag --output=/path/to/dir. This will give you the chance to inspect what we collect before uploading. For large repositories, it is a lot of information, but we never upload your code or any credentials, just the summary data we collect.

Troubleshooting:

Python

  • Run python3 -m pip install --upgrade pip setuptools wheel

git

  • Run which git, git --version
  • Run ssh -vT git@github.com to test access to GitHub

AWS

  • Run which aws, aws --version

Azure

  • Run az git, az --version
  • Run az account subscription list to check subscription Id

Semgrep

  • Run which semgrep, semgrep --version

pip

  • Run which pip
  • If no pip, run: curl -o get-pip.py https://bootstrap.pypa.io/get-pip.py python get-pip.py OR python3 get-pip.py Run sudo apt update

Copyright ©2023-2025 Crosslake Technologies.

Server Schema Verification

Verify that agent output (dependencies + stats) conforms to the server's API schema. Uses the server's tsoa-generated swagger.json as the single source of truth.

Quick check against a local server checkout

./scripts/verify_server_schema.sh              # defaults to ../techlens
./scripts/verify_server_schema.sh /path/to/techlens

Check against a remote GitHub branch

./scripts/verify_server_schema.sh --remote          # uat branch
./scripts/verify_server_schema.sh --remote release   # release branch

Directly via pytest

pytest tests/test_schema_compat.py --server-local ../techlens
pytest tests/test_schema_compat.py --server-branch release

Updating vendored fixtures

When the server schema changes, re-sync the vendored fixtures so CI runs against the latest contract:

python scripts/sync_server_schema.py --local ../techlens   # from local checkout
python scripts/sync_server_schema.py --branch release       # from GitHub

This writes tests/fixtures/server_swagger.json and tests/fixtures/server_stats_schema.json.

Run with Docker Compose

You can build and run the Techlens Agent container with Docker Compose. This mirrors the included run-docker.sh script but makes it easy to pass arguments and reuse mounts.

Build the image

  • docker compose -f docker-compose.yml build techlens-agent

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

techlens_agent-0.7.7.tar.gz (166.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

techlens_agent-0.7.7-py3-none-any.whl (186.7 kB view details)

Uploaded Python 3

File details

Details for the file techlens_agent-0.7.7.tar.gz.

File metadata

  • Download URL: techlens_agent-0.7.7.tar.gz
  • Upload date:
  • Size: 166.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for techlens_agent-0.7.7.tar.gz
Algorithm Hash digest
SHA256 e2b4606a3d2e5b08f57d11decf198311f865c6d3d1685555b18f0f7d05686779
MD5 47910e341a1412d40c0f3fedfc7eb227
BLAKE2b-256 058fc48170a2aa221653be375e71e7f51a46a33ab8f41cfe582a7d2bf679a14a

See more details on using hashes here.

File details

Details for the file techlens_agent-0.7.7-py3-none-any.whl.

File metadata

  • Download URL: techlens_agent-0.7.7-py3-none-any.whl
  • Upload date:
  • Size: 186.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for techlens_agent-0.7.7-py3-none-any.whl
Algorithm Hash digest
SHA256 5ee80c852b92cee4f5d361efe0099f2d833202841cd848f54f0e200064c2dfbc
MD5 f68dbe87c488d662a5fbeee88c83e4ec
BLAKE2b-256 b28cef2d684a440eaa2472a81988260518fcbc1750a0beb32224828c27076222

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page