Skip to content

Commit ac896ae

Browse files
committed
docs: add documentation for --analyze file analysis feature
- Add new "File Analysis with --analyze" section to README.md - Include usage instructions and practical example - Reference analyze.gif demo image Signed-off-by: Pablo Ridolfi <pabloridolfi@gmail.com>
1 parent ce2bd79 commit ac896ae

2 files changed

Lines changed: 40 additions & 0 deletions

File tree

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,46 @@ Do you want to execute this command? [y/N] n
7373
$
7474
```
7575

76+
## File Analysis with `--analyze`
77+
78+
In addition to command suggestions, `sshq` provides AI-powered file analysis capabilities. Use the `--analyze` flag with the `q` command to ask questions about files on your embedded board.
79+
80+
![analyze](docs/images/analyze.gif)
81+
82+
### Usage
83+
84+
```bash
85+
q --analyze <file_path> <your_question>
86+
```
87+
88+
### Example
89+
90+
```
91+
$ q --analyze /proc/cpuinfo What CPU architecture and features does this system have? Explain them briefly.
92+
The system has the following CPU architecture and features:
93+
94+
CPU Architecture:
95+
- 8: This indicates an ARMv8-A architecture, which is a 64-bit instruction set architecture.
96+
97+
CPU Features:
98+
- fp: Floating Point - Hardware support for floating-point arithmetic.
99+
- asimd: Advanced SIMD (Single Instruction, Multiple Data) - Provides parallel processing capabilities for multimedia and signal processing.
100+
- evtstrm: Event Stream - Support for performance monitoring unit (PMU) event streams.
101+
- aes: Advanced Encryption Standard - Hardware acceleration for AES encryption and decryption.
102+
- pmull: Polynomial Multiply - Hardware support for polynomial multiplication, often used in cryptographic operations like GCM.
103+
- sha1: Secure Hash Algorithm 1 - Hardware acceleration for SHA-1 hashing.
104+
- sha2: Secure Hash Algorithm 2 - Hardware acceleration for SHA-2 (SHA-256, SHA-512) hashing.
105+
- crc32: Cyclic Redundancy Check 32-bit - Hardware acceleration for CRC32 calculations, used for data integrity checks.
106+
- atomics: Atomic operations - Hardware support for atomic memory operations, crucial for multi-threaded programming.
107+
- fphp: Half-precision Floating Point - Support for 16-bit half-precision floating-point numbers.
108+
- asimdhp: Half-precision Advanced SIMD - SIMD operations that can operate on half-precision floating-point data.
109+
- cpuid: CPU ID - Instruction to read CPU identification and feature registers.
110+
- asimdrdm: Advanced SIMD Rounding Double Multiply Accumulate - SIMD instructions for rounding double multiply accumulate operations.
111+
- lrcpc: Load-acquire/Release Consistency Point Cache - Support for Load-acquire/Release instructions for memory consistency.
112+
- dcpop: Data Cache Zero - Instruction to zero a cache line without loading it from memory.
113+
- asimddp: Advanced SIMD Dot Product - SIMD instructions for dot product operations, useful for machine learning workloads.
114+
```
115+
76116
## Environment variables
77117

78118
| Variable | Required | Default | Description |

docs/images/analyze.gif

68.2 KB
Loading

0 commit comments

Comments
 (0)